Viiprogrammer
commented
2 years ago 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 | ✅ | ✅ | ✅ |
Review this commits and maybe add some solutions:
Bots API 6.0:
Bots API 6.0 progress ✅
**Add methods for telegram & context:** - [x] [getChatMenuButton](https://core.telegram.org/bots/api#getchatmenubutton) - [x] [setChatMenuButton](https://core.telegram.org/bots/api#setchatmenubutton) - [x] [setMyDefaultAdministratorRights](https://core.telegram.org/bots/api#setmydefaultadministratorrights) - [x] [getMyDefaultAdministratorRights](https://core.telegram.org/bots/api#getmydefaultadministratorrights) - [x] [answerWebAppQuery](https://core.telegram.org/bots/api#answerwebappquery) **Rename message fields for `MessageSubTypes` (maybe with mapping from old to new for more compatibility)** - [x] `voice_chat_scheduled` → `video_chat_scheduled` - [x] `voice_chat_started` → `video_chat_started` - [x] `voice_chat_ended` → `video_chat_ended` - [x] `voice_chat_participants_invited` → `video_chat_participants_invited` **New buttons:** - [x] Add **webApp** button support for `Markup`
Bots API 6.1:
Bots API 6.1 progress ✅
**New webhook feature:** - [x] Add support `secret_token` for webhook (now available in [setWebhook](https://core.telegram.org/bots/api#setwebhook) method) **New methods:** - [x] [createInvoiceLink](https://core.telegram.org/bots/api#createinvoicelink)
Bots API 6.2:
Bots API 6.2 progress ✅
- [x] Update jsdoc for [MessageEntity](https://core.telegram.org/bots/api#messageentity) (custom emoji) - [x] Add shortcut `Composer.customEmoji` for `custom_emoji` entity **New methods:** - [x] [getCustomEmojiStickers](https://core.telegram.org/bots/api#getcustomemojistickers)
Bots API 6.3:
Bots API 6.3 progress ✅
**JSDoc:** Add `is_forum`, `active_usernames`, `emoji_status_custom_emoji_id` to [Chat](https://core.telegram.org/bots/api#chat) object Add `can_manage_topics` to [ChatAdministratorRights](https://core.telegram.org/bots/api#chatadministratorrights), [ChatPermissions](https://core.telegram.org/bots/api#chatpermissions), [ChatMemberAdministrator](https://core.telegram.org/bots/api#chatmemberadministrator), and [ChatMemberRestricted](https://core.telegram.org/bots/api#chatmemberrestricted) Added the parameter `message_thread_id` for [sendMessage](https://core.telegram.org/bots/api#sendmessage), [sendPhoto](https://core.telegram.org/bots/api#sendphoto), [sendVideo](https://core.telegram.org/bots/api#sendvideo), [sendAnimation](https://core.telegram.org/bots/api#sendanimation), [sendAudio](https://core.telegram.org/bots/api#sendaudio), [sendDocument](https://core.telegram.org/bots/api#senddocument), [sendSticker](https://core.telegram.org/bots/api#sendsticker), [sendVideoNote](https://core.telegram.org/bots/api#sendvideonote), [sendVoice](https://core.telegram.org/bots/api#sendvoice), [sendLocation](https://core.telegram.org/bots/api#sendlocation), [sendVenue](https://core.telegram.org/bots/api#sendvenue), [sendContact](https://core.telegram.org/bots/api#sendcontact), [sendPoll](https://core.telegram.org/bots/api#sendpoll), [sendDice](https://core.telegram.org/bots/api#senddice), [sendInvoice](https://core.telegram.org/bots/api#sendinvoice), [sendGame](https://core.telegram.org/bots/api#sendgame), [sendMediaGroup](https://core.telegram.org/bots/api#sendmediagroup), [copyMessage](https://core.telegram.org/bots/api#copymessage), [forwardMessage](https://core.telegram.org/bots/api#forwardmessage) Add the fields: - [x] `is_topic_message` - [x] `message_thread_id` - [x] `forum_topic_created` - [x] `forum_topic_reopened` - [x] `forum_topic_closed` to [Message](https://core.telegram.org/bots/api#message) object Add `can_manage_topics` to the method `promoteChatMember`. **Add `MessageSubTypes` & update JSDoc for forum topics: ** - [x] `forum_topic_created` - [x] `forum_topic_reopened` - [x] `forum_topic_closed` **Add methods for telegram & context:** - [x] [createForumTopic](https://core.telegram.org/bots/api#createforumtopic) - [x] [editForumTopic](https://core.telegram.org/bots/api#editforumtopic) - [x] [closeForumTopic](https://core.telegram.org/bots/api#closeforumtopic) - [x] [reopenForumTopic](https://core.telegram.org/bots/api#reopenforumtopic) - [x] [deleteForumTopic](https://core.telegram.org/bots/api#deleteforumtopic) - [x] [unpinAllForumTopicMessages](https://core.telegram.org/bots/api#unpinallforumtopicmessages) - [x] [getForumTopicIconStickers](https://core.telegram.org/bots/api#getforumtopiciconstickers)
Bots API 6.4 ✅
Bots API 6.5 ✅
Bots API 6.6 ✅
Bots API 6.7 ✅
Docs and other:
[x] Create full change log and migration guide
[x] Add jsdoc comments, types, web reference with clean-jsdoc-theme
JSDoc progress
- [x] composer.js - [x] context.js - [x] extra.js - [x] markup.js - [x] opengram.js - [x] router.js - [x] session.js - [x] stage.js - [x] 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