Telegram Bot API 5.0 Support (yagop#835)

* Add new method sendPoll * getMyCommands * setMyCommands * Update doc/api * 1# Fix Test sendPhoto The sendPhoto method does not support .gif files, use sendAnimation. This fix remplace .gif file by .png * CustomTitle and ChatPermissions support setChatAdministratorCustomTitle setChatPermissions * Update Readme Update Badge Telegram API Version * Minor Fix and Fix setChatPhoto The Telegram Bots api has a bug that they are fixing and gives problems with the previous image. While they don't fix it, the image replacement is the fastest solution * Minor Fix and Add Test Fixed setChatPermissions Test: - sendDice - getMyCommands - setMyCommands - setChatAdministratorCustomTitle - setChatPermissions * Update Changelog and Package.json version * Fix typos in Changelog * Add support for poll_answer From: yagop#777 * Add JieJiSS contribution in Changelog * Add sendPoll Test * Add unpinAllChatMessages Support * Add copyMessage support * Add close and logOut Support * Add Test + Minor fixes * Update CHANGELOG Update version 0.50.1 * Update Readme Bot API Badge * Update Version to 0.51.0
VDS13 · Dec 10, 2020 · 5d30b6a · 5d30b6a
1 parent fc24d0d
commit 5d30b6a
Show file tree

Hide file tree

Showing 6 changed files with 230 additions and 60 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,9 +3,28 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.51.0][0.51.0] - 2020-11-04
+
+Added:
+
+1. Support Bot API v5.0: (by @danielperez9430)
+    * Add method *copyMessage()*
+    * Add method *unpinAllChatMessages()*
+    * Add method *close()*
+    * Add method *logOut()*
+
+  Changed: (by @danielperez9430)
+    * Remove trailing-spaces
+    * Fix Bugs in Test
+
+  New Test: (by @danielperez9430)
+    * copyMessage
+    * unpinAllChatMessages
+
+
 ## [0.50.0][0.50.0] - 2020-05-2020
 
-Added: 
+Added:
 
 1. Support Bot API v4.8: (by @danielperez9430)
    * Add methods: *sendDice()*

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 Node.js module to interact with the official [Telegram Bot API](https://core.telegram.org/bots/api).
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-v.4.8.0-00aced.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-v.5.0-00aced.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api)
 [![npm package](https://img.shields.io/npm/v/node-telegram-bot-api?logo=npm&style=flat-square)](https://www.npmjs.org/package/node-telegram-bot-api)
 [![Build Status](https://img.shields.io/travis/yagop/node-telegram-bot-api/master?style=flat-square&logo=travis)](https://travis-ci.org/yagop/node-telegram-bot-api)
 [![Coverage Status](https://img.shields.io/codecov/c/github/yagop/node-telegram-bot-api?style=flat-square&logo=codecov)](https://codecov.io/gh/yagop/node-telegram-bot-api)

diff --git a/doc/api.md b/doc/api.md
@@ -22,6 +22,8 @@ TelegramBot
         * [.closeWebHook()](#TelegramBot+closeWebHook) ⇒ <code>Promise</code>
         * [.hasOpenWebHook()](#TelegramBot+hasOpenWebHook) ⇒ <code>Boolean</code>
         * [.getMe([options])](#TelegramBot+getMe) ⇒ <code>Promise</code>
+        * [.logOut([options])](#TelegramBot+logOut) ⇒ <code>Promise</code>
+        * [.close([options])](#TelegramBot+close) ⇒ <code>Promise</code>
         * [.setWebHook(url, [options], [fileOptions])](#TelegramBot+setWebHook) ⇒ <code>Promise</code>
         * [.deleteWebHook([options])](#TelegramBot+deleteWebHook) ⇒ <code>Promise</code>
         * [.getWebHookInfo([options])](#TelegramBot+getWebHookInfo) ⇒ <code>Promise</code>
@@ -30,6 +32,7 @@ TelegramBot
         * [.sendMessage(chatId, text, [options])](#TelegramBot+sendMessage) ⇒ <code>Promise</code>
         * [.answerInlineQuery(inlineQueryId, results, [options])](#TelegramBot+answerInlineQuery) ⇒ <code>Promise</code>
         * [.forwardMessage(chatId, fromChatId, messageId, [options])](#TelegramBot+forwardMessage) ⇒ <code>Promise</code>
+        * [.copyMessage(chatId, fromChatId, messageId, [options])](#TelegramBot+copyMessage) ⇒ <code>Promise</code>
         * [.sendPhoto(chatId, photo, [options], [fileOptions])](#TelegramBot+sendPhoto) ⇒ <code>Promise</code>
         * [.sendAudio(chatId, audio, [options], [fileOptions])](#TelegramBot+sendAudio) ⇒ <code>Promise</code>
         * [.sendDocument(chatId, doc, [options], [fileOptions])](#TelegramBot+sendDocument) ⇒ <code>Promise</code>
@@ -52,6 +55,7 @@ TelegramBot
         * [.setChatDescription(chatId, description, [options])](#TelegramBot+setChatDescription) ⇒ <code>Promise</code>
         * [.pinChatMessage(chatId, messageId, [options])](#TelegramBot+pinChatMessage) ⇒ <code>Promise</code>
         * [.unpinChatMessage(chatId, [options])](#TelegramBot+unpinChatMessage) ⇒ <code>Promise</code>
+        * [.unpinAllChatMessages(chatId, [options])](#TelegramBot+unpinAllChatMessages) ⇒ <code>Promise</code>
         * [.answerCallbackQuery(callbackQueryId, [options])](#TelegramBot+answerCallbackQuery) ⇒ <code>Promise</code>
         * [.setMyCommands(commands, [options])](#TelegramBot+setMyCommands) ⇒ <code>Promise</code>
         * [.getMyCommands([options])](#TelegramBot+getMyCommands) ⇒ <code>Promise</code>
@@ -235,6 +239,35 @@ Returns basic information about the bot in form of a `User` object.
 | --- | --- | --- |
 | [options] | <code>Object</code> | Additional Telegram query options |
 
+<a name="TelegramBot+logOut"></a>
+
+### telegramBot.logOut([options]) ⇒ <code>Promise</code>
+This method log out your bot from the cloud Bot API server before launching the bot locally.
+You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. 
+After a successful call, you will not be able to log in again using the same token for 10 minutes. 
+Returns True on success.
+
+**Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
+**See**: https://core.telegram.org/bots/api#logout
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
+<a name="TelegramBot+close"></a>
+
+### telegramBot.close([options]) ⇒ <code>Promise</code>
+This method close the bot instance before moving it from one local server to another.
+This method will return error 429 in the first 10 minutes after the bot is launched. 
+Returns True on success.
+
+**Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
+**See**: https://core.telegram.org/bots/api#close
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
 <a name="TelegramBot+setWebHook"></a>
 
 ### telegramBot.setWebHook(url, [options], [fileOptions]) ⇒ <code>Promise</code>
@@ -354,6 +387,20 @@ Forward messages of any kind.
 | messageId | <code>Number</code> \| <code>String</code> | Unique message identifier |
 | [options] | <code>Object</code> | Additional Telegram query options |
 
+<a name="TelegramBot+copyMessage"></a>
+
+### telegramBot.copyMessage(chatId, fromChatId, messageId, [options]) ⇒ <code>Promise</code>
+Copy messages of any kind.
+
+**Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
+| fromChatId | <code>Number</code> \| <code>String</code> | Unique identifier for the chat where the original message was sent |
+| messageId | <code>Number</code> \| <code>String</code> | Unique message identifier |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
 <a name="TelegramBot+sendPhoto"></a>
 
 ### telegramBot.sendPhoto(chatId, photo, [options], [fileOptions]) ⇒ <code>Promise</code>
@@ -720,7 +767,7 @@ Returns True on success.
 <a name="TelegramBot+unpinChatMessage"></a>
 
 ### telegramBot.unpinChatMessage(chatId, [options]) ⇒ <code>Promise</code>
-Use this method to unpin a message in a supergroup chat.
+Use this method to unpin a message from the list of pinned messages in a chat.
 The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
 Returns True on success.
 
@@ -732,6 +779,21 @@ Returns True on success.
 | chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
 | [options] | <code>Object</code> | Additional Telegram query options |
 
+<a name="TelegramBot+unpinAllChatMessages"></a>
+
+### telegramBot.unpinAllChatMessages(chatId, [options]) ⇒ <code>Promise</code>
+Use this method to clear the list of pinned messages in a chat
+The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
+Returns True on success.
+
+**Kind**: instance method of [<code>TelegramBot</code>](#TelegramBot)
+**See**: https://core.telegram.org/bots/api#unpinallchatmessages
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chatId | <code>Number</code> \| <code>String</code> | Unique identifier for the message recipient |
+| [options] | <code>Object</code> | Additional Telegram query options |
+
 <a name="TelegramBot+answerCallbackQuery"></a>
 
 ### telegramBot.answerCallbackQuery(callbackQueryId, [options]) ⇒ <code>Promise</code>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "node-telegram-bot-api",
-  "version": "0.50.0",
+  "version": "0.51.0",
   "description": "Telegram Bot API",
   "main": "./index.js",
   "directories": {

diff --git a/src/telegram.js b/src/telegram.js
@@ -473,6 +473,31 @@ class TelegramBot extends EventEmitter {
     return this._request('getMe', { form });
   }
 
+  /**
+   * This method log out your bot from the cloud Bot API server before launching the bot locally.
+   * You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates.
+   * After a successful call, you will not be able to log in again using the same token for 10 minutes.
+   * Returns True on success.
+   * @param  {Object} [options] Additional Telegram query options
+   * @return {Promise}
+   * @see https://core.telegram.org/bots/api#logout
+   */
+  logOut(form = {}) {
+    return this._request('logOut', { form });
+  }
+
+  /**
+   * This method close the bot instance before moving it from one local server to another.
+   * This method will return error 429 in the first 10 minutes after the bot is launched.
+   * Returns True on success.
+   * @param  {Object} [options] Additional Telegram query options
+   * @return {Promise}
+   * @see https://core.telegram.org/bots/api#close
+   */
+  close(form = {}) {
+    return this._request('close', { form });
+  }
+
   /**
    * Specify an url to receive incoming updates via an outgoing webHook.
    * This method has an [older, compatible signature][setWebHook-v0.25.0]
@@ -712,6 +737,7 @@ class TelegramBot extends EventEmitter {
    * @param  {Number|String} messageId  Unique message identifier
    * @param  {Object} [options] Additional Telegram query options
    * @return {Promise}
+   * @see https://core.telegram.org/bots/api#forwardmessage
    */
   forwardMessage(chatId, fromChatId, messageId, form = {}) {
     form.chat_id = chatId;
@@ -720,6 +746,26 @@ class TelegramBot extends EventEmitter {
     return this._request('forwardMessage', { form });
   }
 
+  /**
+   * Copy messages of any kind.
+   * The method is analogous to the method forwardMessages, but the copied message doesn't
+   * have a link to the original message.
+   * Returns the MessageId of the sent message on success.
+   * @param  {Number|String} chatId     Unique identifier for the message recipient
+   * @param  {Number|String} fromChatId Unique identifier for the chat where the
+   * original message was sent
+   * @param  {Number|String} messageId  Unique message identifier
+   * @param  {Object} [options] Additional Telegram query options
+   * @return {Promise}
+   * @see https://core.telegram.org/bots/api#copymessage
+   */
+  copyMessage(chatId, fromChatId, messageId, form = {}) {
+    form.chat_id = chatId;
+    form.from_chat_id = fromChatId;
+    form.message_id = messageId;
+    return this._request('copyMessage', { form });
+  }
+
   /**
    * Send photo
    * @param  {Number|String} chatId  Unique identifier for the message recipient
@@ -1202,6 +1248,21 @@ class TelegramBot extends EventEmitter {
     return this._request('unpinChatMessage', { form });
   }
 
+   /**
+   * Use this method to clear the list of pinned messages in a chat
+   * The bot must be an administrator in the chat for this to work and must have the appropriate admin rights.
+   * Returns True on success.
+   *
+   * @param  {Number|String} chatId  Unique identifier for the message recipient
+   * @param  {Object} [options] Additional Telegram query options
+   * @return {Promise}
+   * @see https://core.telegram.org/bots/api#unpinallchatmessages
+   */
+  unpinAllChatMessages(chatId, form = {}) {
+    form.chat_id = chatId;
+    return this._request('unpinAllChatMessages', { form });
+  }
+
   /**
    * Use this method to send answers to callback queries sent from
    * inline keyboards. The answer will be displayed to the user as