Roadmap 1.0 (will be updated)

[Viiprogrammer]

This list is tentative. Things may be added or removed if we figure that that makes sense.

Review this commits and maybe add some solutions:

• telegraf/telegraf@f425a05
• telegraf/telegraf@d87554c ( performance optimization for composer?)

---

Bots API 6.0:

Bots API 6.0 progress ✅

---

Add methods for telegram & context:

• getChatMenuButton
• setChatMenuButton
• setMyDefaultAdministratorRights
• getMyDefaultAdministratorRights
• answerWebAppQuery

Rename message fields for MessageSubTypes (maybe with mapping from old to new for more compatibility)

• voice_chat_scheduled → video_chat_scheduled
• voice_chat_started → video_chat_started
• voice_chat_ended → video_chat_ended
• voice_chat_participants_invited → video_chat_participants_invited

New buttons:

• Add webApp button support for Markup

---

Bots API 6.1:

Bots API 6.1 progress ✅

---

New webhook feature:

• Add support secret_token for webhook (now available in setWebhook method)

New methods:

• createInvoiceLink

---

Bots API 6.2:

Bots API 6.2 progress ✅

---

• Update jsdoc for MessageEntity (custom emoji)
• Add shortcut Composer.customEmoji for custom_emoji entity

New methods:

• getCustomEmojiStickers

---

---

Bots API 6.3:

Bots API 6.3 progress ✅

---

JSDoc:
Add is_forum, active_usernames, emoji_status_custom_emoji_id to Chat object

Add can_manage_topics to ChatAdministratorRights, ChatPermissions, ChatMemberAdministrator, and ChatMemberRestricted

Added the parameter message_thread_id for sendMessage, sendPhoto, sendVideo, sendAnimation, sendAudio, sendDocument, sendSticker, sendVideoNote, sendVoice, sendLocation, sendVenue, sendContact, sendPoll, sendDice, sendInvoice, sendGame, sendMediaGroup, copyMessage, forwardMessage

Add the fields:

• is_topic_message
• message_thread_id
• forum_topic_created
• forum_topic_reopened
• forum_topic_closed

to Message object

Add can_manage_topics to the method promoteChatMember.

**Add MessageSubTypes & update JSDoc for forum topics: **

• forum_topic_created
• forum_topic_reopened
• forum_topic_closed

Add methods for telegram & context:

• createForumTopic
• editForumTopic
• closeForumTopic
• reopenForumTopic
• deleteForumTopic
• unpinAllForumTopicMessages
• getForumTopicIconStickers

Bots API 6.4 ✅

Bots API 6.5 ✅

Bots API 6.6 ✅

Bots API 6.7 ✅

---

Docs and other:

• Create full change log and migration guide
• Add jsdoc comments, types, web reference with clean-jsdoc-theme

JSDoc progress

• composer.js
• context.js
• extra.js
• markup.js
• opengram.js
• router.js
• session.js
• stage.js
• telegram.js

• Create full, actual, good examples

Examples progress

• Extra
• Markup
• Scenes, Wizards, Stage
• Composer
• Webhook
• Media
• Session
• Custom context
• Web Apps
• Inline bot

• Rewrite sessions

• API Interceptors

• Mixins

[Viiprogrammer]

JSDoc documantation:

Telegram API (telegram.js) documentation progress ✅ (exclude `sendCopy`)

---

Method	Documentation started	Reviewed	Complete
getMe	✅	✅	✅
getFile	✅	✅	✅
getFileLink	✅	✅	✅
getUpdates	✅	✅	✅
getWebhookInfo	✅	✅	✅
getGameHighScores	✅	✅	✅
setGameScore	✅	✅	✅
setWebhook	✅	✅	✅
deleteWebhook	✅	✅	✅
sendMessage	✅	✅	✅
forwardMessage	✅	✅	✅
sendChatAction	✅	✅	✅
getUserProfilePhotos	✅	✅	✅
sendLocation	✅	✅	✅
sendVenue	✅	✅	✅
sendInvoice	✅	✅	✅
sendContact	✅	✅	✅
sendPhoto	✅	✅	✅
sendDice	✅	✅	✅
sendDocument	✅	✅	✅
sendAudio	✅	✅	✅
sendSticker	✅	✅	✅
sendVideo	✅	✅	✅
sendAnimation	✅	✅	✅
sendVideoNote	✅	✅	✅
sendVoice	✅	✅	✅
sendGame	✅	✅	✅
sendMediaGroup	✅	✅	✅
sendPoll	✅	✅	✅
sendQuiz	✅	✅	✅
stopPoll	✅	✅	✅
getChat	✅	✅	✅
getChatAdministrators	✅	✅	✅
getChatMember	✅	✅	✅
getChatMembersCount	✅	✅	✅
getChatMemberCount	✅	✅	✅
answerInlineQuery	✅	✅	✅
setChatPermissions	✅	✅	✅
banChatMember	✅	✅	✅
kickChatMember	✅	✅	✅
promoteChatMember	✅	✅	✅
restrictChatMember	✅	✅	✅
banChatSenderChat	✅	✅	✅
unbanChatSenderChat	✅	✅	✅
setChatAdministratorCustomTitle	✅	✅	✅
exportChatInviteLink	✅	✅	✅
setChatPhoto	✅	✅	✅
deleteChatPhoto	✅	✅	✅
setChatTitle	✅	✅	✅
setChatDescription	✅	✅	✅
pinChatMessage	✅	✅	✅
unpinChatMessage	✅	✅	✅
unpinAllChatMessages	✅	✅	✅
getChatMenuButton	✅	✅	✅
setChatMenuButton	✅	✅	✅
setMyDefaultAdministratorRights	✅	✅	✅
getMyDefaultAdministratorRights	✅	✅	✅
leaveChat	✅	✅	✅
unbanChatMember	✅	✅	✅
answerCbQuery	✅	✅	✅
answerGameQuery	✅	✅	✅
answerShippingQuery	✅	✅	✅
answerPreCheckoutQuery	✅	✅	✅
editMessageText	✅	✅	✅
editMessageCaption	✅	✅	✅
editMessageMedia	✅	✅	✅
editMessageReplyMarkup	✅	✅	✅
editMessageLiveLocation	✅	✅	✅
stopMessageLiveLocation	✅	✅	✅
deleteMessage	✅	✅	✅
setChatStickerSet	✅	✅	✅
deleteChatStickerSet	✅	✅	✅
getStickerSet	✅	✅	✅
uploadStickerFile	✅	✅	✅
createNewStickerSet	✅	✅	✅
addStickerToSet	✅	✅	✅
setStickerPositionInSet	✅	✅	✅
setStickerSetThumb	✅	✅	✅
deleteStickerFromSet	✅	✅	✅
getMyCommands	✅	✅	✅
setMyCommands	✅	✅	✅
deleteMyCommands	✅	✅	✅
setPassportDataErrors	✅	✅	✅
sendCopy	✅	⬜️	⬜️
copyMessage	✅	✅	✅
createChatInviteLink	✅	✅	✅
editChatInviteLink	✅	✅	✅
revokeChatInviteLink	✅	✅	✅
approveChatJoinRequest	✅	✅	✅
declineChatJoinRequest	✅	✅	✅

Markup (markup.js) documentation progress ✅

---

Method	Documentation started	Reviewed	Complete
forceReply	✅	✅	✅
removeKeyboard	✅	✅	✅
inputFieldPlaceholder	✅	✅	✅
selective	✅	✅	✅
extra	✅	✅	✅
keyboard	✅	✅	✅
inlineKeyboard	✅	✅	✅
resize	✅	✅	✅
oneTime	✅	✅	✅
button	✅	✅	✅
contactRequestButton	✅	✅	✅
locationRequestButton	✅	✅	✅
pollRequestButton	✅	✅	✅
urlButton	✅	✅	✅
callbackButton	✅	✅	✅
switchToChatButton	✅	✅	✅
switchToCurrentChatButton	✅	✅	✅
gameButton	✅	✅	✅
payButton	✅	✅	✅
loginButton	✅	✅	✅
webApp	✅	✅	✅
static removeKeyboard	✅	✅	✅
static forceReply	✅	✅	✅
static keyboard	✅	✅	✅
static inlineKeyboard	✅	✅	✅
static resize	✅	✅	✅
static sendGame	✅	✅	✅
static inputFieldPlaceholder	✅	✅	✅
static selective	✅	✅	✅
static oneTime	✅	✅	✅
static button	✅	✅	✅
static contactRequestButton	✅	✅	✅
static locationRequestButton	✅	✅	✅
static pollRequestButton	✅	✅	✅
static urlButton	✅	✅	✅
static callbackButton	✅	✅	✅
static switchToChatButton	✅	✅	✅
static switchToCurrentChatButton	✅	✅	✅
static gameButton	✅	✅	✅
static payButton	✅	✅	✅
static loginButton	✅	✅	✅
static webApp	✅	✅	✅
static formatHTML	✅	✅	✅
function buildKeyboard	✅	✅	✅

Extrta (extra.js) documentation progress ✅

---

Method	Documentation started	Reviewed	Complete
load	✅	✅	✅
inReplyTo	✅	✅	✅
notifications	✅	✅	✅
webPreview	✅	✅	✅
markup	✅	✅	✅
HTML	✅	✅	✅
markdown	✅	✅	✅
markdownV2	✅	✅	✅
caption	✅	✅	✅
entities	✅	✅	✅
captionEntities	✅	✅	✅
inReplyTo	✅	✅	✅
notifications	✅	✅	✅
webPreview	✅	✅	✅
load	✅	✅	✅
switchToChatButton	✅	✅	✅
switchToCurrentChatButton	✅	✅	✅
static markup	✅	✅	✅
static entities	✅	✅	✅
static HTML	✅	✅	✅
static markdown	✅	✅	✅
static markdownV2	✅	✅	✅
static caption	✅	✅	✅
static captionEntities	✅	✅	✅

Stage (stage.js) documentation progress ✅

---

Method	Documentation started	Reviewed	Complete
constructor	✅	✅	✅
register	✅	✅	✅
middleware	✅	✅	✅
enter	✅	✅	✅
reenter	✅	✅	✅
leave	✅	✅	✅

Composer (composer.js) documentation progress

---

Method	Documentation started	Reviewed	Complete
constructor	✅	✅	✅
use	✅	✅	✅
on	✅	✅	✅
hears	✅	✅	✅
command	✅	✅	✅
action	✅	✅	✅
inlineQuery	✅	✅	✅
gameQuery	✅	✅	✅
drop	✅	✅	✅
filter	✅	✅	✅
entity	✅	✅	✅
email	✅	✅	✅
phone	✅	✅	✅
url	✅	✅	✅
textLink	✅	✅	✅
textMention	✅	✅	✅
mention	✅	✅	✅
hashtag	✅	✅	✅
cashtag	✅	✅	✅
spoiler	✅	✅	✅
reply	✅	✅	✅
log	✅	✅	✅
branch	✅	✅	✅

Router (router.js) documentation progress ✅

---

Method	Documentation started	Reviewed	Complete
constructor	✅	✅	✅
on	✅	✅	✅
otherwise	✅	✅	✅

[Viiprogrammer]

Sessions:

• abstract-level / Map compatibility
• Asynchronous / Synchronous store support
• Lazy update (optional, enabling with session options)
  Update session only if changed (via Proxy)
• Migrations
• Docs for using with custom / external storage

[Viiprogrammer]

Interactive docusaurus docs

• Deploy guides for popular clouds / services
• Bots API, Self-hosted Bots API, TDLight
• Framework API
• Plugins docs
• Bots architecture, decomposition, scale
• CI / CD
• Hosting comparison
• Advanced debug / logging
• Interactive live examples
• Troubleshooting
• Diagrams
• Quizzes / tests