televerse

• Webhook now accepts a shouldSetWebhook flag which indicates whether the setWebhook call to be made implicitly or not.
• Made the url property optional in Webhook.
• Minor tweaks

• 🤖 Bot API 7.6
• Added methods to register callbacks for handling paid media in bot messages:
  • Bot.onPaidMedia: Registers a callback for whenever any type of paid media is received in messages.
  • Bot.onPaidMediaVideo: Registers a callback for whenever paid media videos are received in messages.
  • Bot.onPaidMediaPhoto: Registers a callback for whenever paid media photos are received in messages.
• New method RawAPI.sendPaidMedia is added to send paid media.

• 🥳 Support for Custom Context
• Added detailed usage documentation for custom context here.
• The custom context feature allows you to extend the base functionality of your bot by using your own custom context classes.
• Added Bot.contextBuilder method
• Refactors across the library to cope with <CTX extends Context>
  • Refactored Bot, Handler, Fetcher, Menu, BotError, Conversation etc.
• Fixed an issue in KeyboardMenu that caused some features not to work.
• Added documentation on almost all new classes and typedefs.

• 🧑🏻‍🔧 Fix in InlineQueryResultBuilder methods voice and video.
• Improved Webhook implementation. Works perfect now!
• Added example for building bot with Webhook fetcher in Examples Repo
• Added detailed documentation for InlineQueryResultBuilder and Webhook classes.

• Minor README fix
• Fixes in documentation comments

• Changed return type of the Transformer.transform from FutureOr<Map<String, dynamic>> to Future<Map<String, dynamic>> because it'll always have to return a Future.
• Minor type adjustment on the typedef PayloadFiles.
• ✨ Two new plugins are released for Televerse: auto_chat_action and parse_mode_setter

• ⚠️ Changed the Transformer.transform method definition.
• Improved the Transformer class
• Added new class Payload to accept payload to the API calls
• Added typedef APICaller for the method which actually invokes the API endpoinds.

• 🆕 Support for Middlewares & Transformers
• Middlewares lets you attach handlers that are run before your main handler is executed.
• Added Middleware class to create a middleware.
• Added Transformer class to create a transformer.
• A Transformer can be attached to the RawAPI which then can alter the request payload.
• Added use method on Bot, Context and RawAPI to attach middlewares.
• Added default error handler method. Now, bot will crash with a pretty message.
• Added Context.middlewareStorage as a Map<String, dynamic> to store any output from middleware functions.
• ✍️ Bot.onStop method can now be asynchronous. #257 (Thanks to @devsdocs)
• ⚠️ Type of Webhook.certificate is changed to InputFile as described by the official documentation.
• Added examples for Middleware and Transformer usage in Examples repo.

• [Retracted]

• 🤖 Bot API 7.5
• Improved context aware methods
• Added WithID abstraction

• Added considerCaption parameter in Bot.command mehtod to match commands in the caption of video/photo messages.
• 🐞 Fixed: JSON parsing bug in UsersShared causing the users field to be null and resulting in crashes.

• ‼️ Strict typing for ctx.editMessageMedia and ctx.editMessageReplyMarkup
• Fix: ChatID constuctor accepted dynamic

• 🤖 Bot API 7.4 (May 28, 2024)
• Refactors and formatting improvements

• 🤖 Bot API 7.3 (May 6, 2024)
• Added Keyboard.remove method to remove Keyboard.
• Refactors and improvements

• Removed unnecessary print in the callback setter.
• Fixed BotLink link generation.

• Removed usage of dart:mirrors
• Updated README

• Fix: Forked Handlers caused crash.

• Minor fix in update processing
• Added businessConnectionId to Context aware methods.

• Added Bot.fromAPI constructor for creating Bot instance from RawAPI instance.
• Bot.command, Bot.text, Bot.hears, and many more methods now listens to all Message types (Message, Channel Posts, and edited messages of both)
• ⚠️ Added chatId parameter to Bot.shippingQuery and Bot.preCheckoutQuery.
• Refactored code for quality and better readability and added docs.
• Added ScopeOptions class that can contain additional info for handler scope.
• ScopeOptions.forked to create forked handlers. Forked handlers are run without conditions.
• ScopeOptions.customPredicate can be used to set a middleware to check if the update should be processed or skipped.
• Migrated to Dart 3.0.0
• Bot.removeScope can be used to remove already set handlers.
• Accepts ScopeOption on both menus as well.

• Improved efficiency by removing redundant getMe calls while registering command handlers and whenMentioned handlers.
• Made LongPolling.allowedUpdates nullable, and removed the constant empty list initialization.
• Updated the README.

• Introducing TGException enum which is a collection of different possible Telegram exceptions binded with their reasons and possible solutions.
• Added LoggerOptions.only method to turn on logging for ONLY specified actions.
• Prints resposne data if any on exception with Logger.
• Prints StackTrace along with uncaught TelegramException errors.

• Context.args will no longer return null.
• ⚠️ Updated RawAPI constructor
• Updated DartDoc comments for the Bot.command method.
• Added new methods to Keyboard for simplicity.

• Added missing methods in the InlineKeyboard

• Completes the helper class MessageContentGenerator for ease of use to create InputMessageContent.
• All types of InputMessageContent can be now generated with the new MessageContentGenerator methods text, location, venue, contact and invoice.
• Updated README, and added an example for handling inline queries.

• 🆕 InlineQueryResultBuilder utility class is added
• The InlineQueryResultBuilder can be used to build Inline Query Results in a better and easier way.
• Made callback_data required for InlineMenu.text
• 👨🏻‍🔧 Fix createNewStickerSet (Thanks to @defuera for pointing out the issue.)
• Removed unnecessary JSON encodings
• Improved LoggerOptions and logging the requests and responses.
• Refactors around ForceReply, ChatMember, etc.

• Fix InputSticker conversion to json 🤦 (thx @defuera)

• Add missing field InputStickerFormat to InputSticker class. (Thanks to @defuera)
• Generic typing removed for HandlerScope (This doesn't affect anything on the public API)

• Fix an issue with the RawAPI.banChatMember (Thanks to @Sominemo for #223)

• 🤖 Bot API 7.2!
• All changes from the Bot API 7.2 is added to this release.
• Added the methods Bot.onBusinessConnection, Bot.onBusinessMessage, Bot.onBusinessMessageEdited, Bot.onBusinessMessageDeleted to handle business messages and connection related updates.
• Added Context.businessConnection, Context.businessMessage, Context.editedBusinessMessage, Context.businessMessageDelete getters to get the business connection, business message, edited business message, and business message delete updates respectively.

• 🆕 Whole new version of TeleverseMenu
• Both InlineMenu and KeyboardMenu are now can be used to create menus with all available button types.
• ‼️ BREAKING: Removed the Session, SessionManager, and all Televerse Session related methods and properties.
• Refactored the Unix Time to DateTime conversion.

• Added a new property timeout to Bot and RawAPI classes to set the timeout for the API requests.
• The timeout does not affect the long polling (getUpdates) requests.
• Added TeleverseExceptionType to categorize the exceptions that can be thrown from the Televerse library.
• The TeleverseException class now has a type property to represent the type of the exception.
• Added RawAPI.closeClient method to close the HTTP client.
• Removed the HttpClient export.

• Fix #212 - setChatMenuButton required ID instance where it should be optional.
• Thanks to @Sominemo for raising this issue.

• 🤖 Bot API 7.1 is here.
• Refer to official changelog here.

• Improved the Conversation API to make it easier and more efficient to use.
• Added the parameter clearUnfulfilled (true by default) to all waitFor methods in Conversation which will clear the unfulfilled Conversation listeners when new one is attached.
• Added Conversation.clear and Conversation.clearAll methods to clear attached listeners.
• All conversation method now return nullable Context object, this is because when clearing the unfulfilled listeners, the method will return null.
• Added ConversationException class to represent the exceptions that can be thrown from the Conversation class. For now, the only exception that can possibly be thrown is the Timeout Exception.

• All Televerse listeners are now based on the single Context class.
• Removed all the different Context subclasses, such as MessageContext, InlineQueryContext, CallbackQueryContext etc.
• Added context-aware methods for almost all the methods in the RawAPI class.
• Conversation.waitFor methods no longer accepts generic type. All the methods return the Context class.

• Now Televerse uses APIMethod instead of hard coded strings to call API endpoints.
• Cleared missing APIMethod implementations and typos.
• Cleaned up the code.

• Updated Example File

• Added ID parameter to toJson of many InlineQueryResult classes.

• Implemented MessageOrigin.fromJson which was part of the Bot API 7.0

• Made almost all models to have const constructors
• Bot.inlineQuery method is updated to accept Pattern query to listen to inline queries that match the passed pattern. It had an unintended behavior before.
• Updated toString on InlineQueryResultType enum for it to work with RawAPI.answerInlineQuery

• Fixed an issue with the InlineKeyboardButton class that caused a crash when webAppInfo parameter is set. (#190)

• Bot API 7.0 (December 29, 2023)

Reactions! 🎉

• New Context objects, MessageReactionContext & MessageReactionCountUpdatedContext to represent message_reaction and message_reaction_count updates respectively.
• Added Televerse.onMessageReaction and Televerse.onMessageReactionCount methods to listen to message_reaction and message_reaction_count updates respectively.
• 🆕 Added methods MessageContext.react and MessageContext.reactMultiple to react to a message.
• 🆕 Added Televerse.whenReacted method to listen to particular reactions on a message.

Replies 2.0 🗯

• ⚠️ BREAKING: Replaced all usages of replyToMessageId and allowSendingWithoutReply parameters with replyParameters of Type ReplyParameters.
• ⚠️ Affected methods on RawAPI: copyMessage, sendMessage, sendPhoto, sendVideo, sendAnimation, sendAudio, sendDocument, sendSticker, sendVideoNote, sendVoice, sendLocation, sendVenue, sendContact, sendPoll, sendDice, sendInvoice, sendGame, and sendMediaGroup.
• ⚠️ Affected methods on MessageContext: reply, replyWithPhoto, replyWithAudio, replyWithDocument, replyWithVideo, replyWithVideoNote, replyWithVoice, replyWithMediaGroup, replyWithLocation, replyWithVenue, replyWithContact, replyWithPoll, replyWithDice, replyWithGame, replyWithAnimation, replyWithSticker.

Link Preview Customization 📎

• ⚠️ BREAKING: Replaced the parameter disableWebPagePreview with linkPreviewOptions in the methods RawAPI.sendMessage and RawAPI.editMessageText.
• ⚠️ Affected methods on Televerse: ChatJoinRequestContext.replyToUser, ChatMemberUpdatedContext.replyToUser, CallbackQueryContext.editMessage, MessageContext.reply, and MessageContext.editMessageText.
• ⚠️ BREAKING: InputTextMessageContent.disableWebPagePreview is now renamed to InputTextMessageContent.linkPreviewOptions and the type is changed to LinkPreviewOptions.

Multiple Message Actions 📨

• Added deleteMessages, forwardMessages, and copyMessages

Request for multiple users 🙋‍♂️

• ⚠️ BREAKING: KeyboardButton.requestUser is now renamed as KeyboardButton.requestUsers and the type is changed to KeyboardButtonRequestUsers.
• Renamed the class KeyboardButtonRequestUser to KeyboardButtonRequestUsers and added the field max_quantity to it.
• Renamed the field request_user in the class KeyboardButton to request_users.
• Added the class UsersShared.
• Replaced the field user_shared in the class Message with the field users_shared.

Chat Boosts 🚀

• 🆕 New methods to listen the ChatBoostUpdated and ChatBoostRemoved updates, respectively Televerse.onChatBoosted, Televerse.onChatBoostRemoved are added.
• 🆕 New context objects ChatBoostUpdatedContext and ChatBoostRemovedContext are added.

Other Changes 🎉

• Updated Chat model to reflect the changes in the API.
• ⚠️ BREAKING: Added the class MessageOrigin and replaced the fields forward_from, forward_from_chat, forward_from_message_id, forward_signature, forward_sender_name, and forward_date with the field forwardOrigin of type MessageOrigin in the class Message.
• ⚠️ BREAKING: CallbackQuery.message is now of the type MaybeInaccessibleMessage instead of Message.

• Made the parameters inside OrderInfo class nullable as per the documentation.
• Thanks to @Defuera for the contribution.

• Refactored the code to make it easier to maintain.
• Added lints as a dev dependency.

• Added [Televerse.onSuccessfulPayment] method to listen to successful payments service messages #158`, thanks to @Defuera for the suggestion and @GiuseppeFn for the contribution.

• Fixed an issue with the InlineKeyboardButton class that caused a crash when webAppInfo parameter is set.
• Moved all Telegram Models into one file. This will make it easier to maintain the code.

• 🤖 Telegram Bot API 6.9 (September 22, 2023)
• Examples are now moved to the Examples Repo
• Updated Example files.

• 🤖 Telegram Bot API 6.8 (August 18, 2023)
• Possibly breaking: The PollAnswer.user property is now returns a nullable User object.

• Using LoggerOptions unknowingly caused the bot to crash. This is now fixed.
• Thanks to @iamcosmin for raising #148.
• Fixed an issue with the Http client that caused the bot to crash when an exception is received from the Telegram Bot API.
• Thanks to @OttomanDeveloper for raising #151.
• Added Televerse.onCommand method to listen to all commands - #150 by @Defuera.

• Added LoggerOptions class to configure the logger.
• Now the Televerse class accepts a LoggerOptions object to setup logging requests and responses to and from the Telegram Bot API.
• Added the APIMethod enum to represent the Telegram Bot API methods.
• You can pass the List of APIMethod to the LoggerOptions class to log only the specified methods. By default all methods will be logged.

• Added Televerse.setNextStep method which can be used to set next step handler.
• Catches DioExceptions and throws meaningful exceptions.

• ⚠️ BREAKING CHANGES
• Added BotError class that will be passed to the Televerse.onError handler
• ⚠️ Televerse.onError will now only accept one parameter which is instance of BotError
• ⚠️ Made the InputFile constructor private. Use InputFile.fromFile or InputFile.fromBytes or InputFile.fromUrl or InputFile.fromFileId to create an InputFile instance.
• 🆕 Added the InputFile.fromBytes constructor to create an InputFile instance from a Uint8List object.
• ⚙️ Migrated to dio instead of http package.
• Refactors & tets

• Fixed a minor formatting issue

• Fix #135 - Methods in MessageContext failed to work when message is in a General Topic of a Forum.
• Improved error handling.
• All exceptions thrown inside handler methods will now be caught and passed to the onError method.
• That is no more unexpected crashes even if you don't handle the exceptions inside the handler methods.
• Removed some unnecessary code.
• Updated long polling error handling.

• Fix #130 - RawAPI.editMessageMedia method now works as expected.
• Added callback data to InlineMenu - #129 (Thanks to @devsdocs).
• Now all RawAPI methods uses HTTP POST / Multipart POST requests instead of GET requests.