feat: Keyboard interface introduced

Author: trakhimenok

tgbotapi/configs.go

@@ -111,11 +111,11 @@ type Fileable interface {
 
 // BaseChat is a base type for all chat config types.
 type BaseChat struct {
-	ChatID              int64       `json:"chat_id,omitempty"`
-	ChannelUsername     string      `json:"channel_username,omitempty"`
-	ReplyToMessageID    int         `json:"reply_to_message_id,omitempty"`
-	ReplyMarkup         interface{} `json:"reply_markup,omitempty"`
-	DisableNotification bool        `json:"disable_notification,omitempty"`
+	ChatID              int64  `json:"chat_id,omitempty"`
+	ChannelUsername     string `json:"channel_username,omitempty"`
+	ReplyToMessageID    int    `json:"reply_to_message_id,omitempty"`
+	ReplyMarkup         any    `json:"reply_markup,omitempty"`
+	DisableNotification bool   `json:"disable_notification,omitempty"`
 
 	ProtectContent bool `json:"protect_content,omitempty"` // Protects the contents of the sent message from forwarding and saving
 

tgbotapi/keyboard.go

@@ -0,0 +1,10 @@
+package tgbotapi
+
+import "github.com/bots-go-framework/bots-go-core/botkb"
+
+type keyboardType string
+
+type Keyboard interface {
+	botkb.Keyboard
+	telegramKeyboardType() keyboardType
+}

tgbotapi/message.go

@@ -3,6 +3,7 @@ package tgbotapi
 //go:generate ffjson $GOFILE
 
 import (
+	"strconv"
 	"strings"
 	"time"
 )
@@ -95,6 +96,10 @@ type Message struct {
 	UniqueGift *UniqueGiftInfo `json:"unique_gift,omitempty"`
 }
 
+func (m *Message) GetMessageID() string {
+	return strconv.Itoa(m.MessageID)
+}
+
 // Time converts the message timestamp into a Time.
 func (m *Message) Time() time.Time {
 	return time.Unix(int64(m.Date), 0)

tgbotapi/types.go

@@ -295,21 +295,51 @@ func (f *File) Link(token string) string {
 	return fmt.Sprintf(FileEndpoint, token, f.FilePath)
 }
 
+var _ botkb.Keyboard = (*ReplyKeyboardMarkup)(nil)
+var _ Keyboard = (*ReplyKeyboardMarkup)(nil)
+
 // ReplyKeyboardMarkup allows the Bot to set a custom keyboard.
 type ReplyKeyboardMarkup struct {
-	Keyboard        [][]KeyboardButton `json:"keyboard"`
-	ResizeKeyboard  bool               `json:"resize_keyboard,omitempty"`   // optional
-	OneTimeKeyboard bool               `json:"one_time_keyboard,omitempty"` // optional
-	Selective       bool               `json:"selective,omitempty"`         // optional
+	// Array of button rows, each represented by an Array of KeyboardButton objects
+	Keyboard [][]KeyboardButton `json:"keyboard"`
+
+	// Optional. Requests clients to always show the keyboard when the regular keyboard is hidden.
+	// Defaults to false, in which case the custom keyboard can be hidden and opened with a keyboard icon.
+	IsPersistent bool `json:"is_persistent,omitempty"`
+
+	// Optional. Requests clients to resize the keyboard vertically for optimal fit
+	// (e.g., make the keyboard smaller if there are just two rows of buttons).
+	// Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
+	ResizeKeyboard bool `json:"resize_keyboard,omitempty"` // optional
+
+	// Optional. Requests clients to hide the keyboard as soon as it's been used.
+	// The keyboard will still be available, but clients will automatically display the usual letter-keyboard
+	// in the chat - the user can press a special button in the input field to see the custom keyboard again.
+	//Defaults to false.
+	OneTimeKeyboard bool `json:"one_time_keyboard,omitempty"` // optional
+
+	// Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
+	InputFieldPlaceholder string `json:"input_field_placeholder,omitempty"`
+
+	// Optional. Use this parameter if you want to show the keyboard to specific users only.
+	// Targets:
+	//  1) users that are @mentioned in the text of the Message object;
+	//  2) if the bot's message is a reply to a message in the same chat and forum topic, sender of the original message.
+	//
+	// Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language.
+	// Other users in the group don't see the keyboard.
+	Selective bool `json:"selective,omitempty"` // optional
+}
+
+func (m *ReplyKeyboardMarkup) telegramKeyboardType() keyboardType {
+	return "reply_keyboard"
 }
 
 // KeyboardType returns KeyboardTypeBottom
 func (*ReplyKeyboardMarkup) KeyboardType() botkb.KeyboardType {
 	return botkb.KeyboardTypeBottom
 }
 
-var _ botkb.Keyboard = (*ReplyKeyboardMarkup)(nil)
-
 // KeyboardButtonRequestUsers represents a request from the bot to send users
 // https://core.telegram.org/bots/api#keyboardbuttonrequestusers
 type KeyboardButtonRequestUsers struct {
@@ -435,24 +465,36 @@ func (v WebAppInfo) Validate() error {
 	return nil
 }
 
+var _ botkb.Keyboard = (*ReplyKeyboardHide)(nil)
+var _ Keyboard = (*ReplyKeyboardHide)(nil)
+
 // ReplyKeyboardHide allows the Bot to hide a custom keyboard.
 type ReplyKeyboardHide struct {
 	HideKeyboard bool `json:"hide_keyboard"`
 	Selective    bool `json:"selective,omitempty"` // optional
 }
 
+func (h *ReplyKeyboardHide) telegramKeyboardType() keyboardType {
+	return "ReplyKeyboardHide"
+}
+
 // KeyboardType returns KeyboardTypeHide
 func (*ReplyKeyboardHide) KeyboardType() botkb.KeyboardType {
 	return botkb.KeyboardTypeHide
 }
 
-var _ botkb.Keyboard = (*ReplyKeyboardHide)(nil)
+var _ botkb.Keyboard = (*InlineKeyboardMarkup)(nil)
+var _ Keyboard = (*InlineKeyboardMarkup)(nil)
 
 // InlineKeyboardMarkup is a custom keyboard presented for an inline bot.
 type InlineKeyboardMarkup struct {
 	InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
 }
 
+func (v *InlineKeyboardMarkup) telegramKeyboardType() keyboardType {
+	return "InlineKeyboardMarkup"
+}
+
 func (v *InlineKeyboardMarkup) Validate() error {
 	for _, row := range v.InlineKeyboard {
 		for _, button := range row {
@@ -469,8 +511,6 @@ func (*InlineKeyboardMarkup) KeyboardType() botkb.KeyboardType {
 	return botkb.KeyboardTypeInline
 }
 
-var _ botkb.Keyboard = (*InlineKeyboardMarkup)(nil)
-
 // LoginUrl represents a parameter of the inline keyboard button used to automatically authorize a user.
 // https://core.telegram.org/bots/api#loginurl
 type LoginUrl struct {