@zero-bot.net/tg-bot-api 1.0.0

package/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing
+
+> If you are willing to contribute, first you should know that
+> I will love you and so will the Telegram Bot community.
+
+Before proceeding any further, read the following documents:
+
+1. [Code of Conduct][coc]
+1. [License][license]
+
+## General Information
+
+### Creating a Github issue:
+
+1. Ensure that your issue does **not** already exist. [Do a search](https://github.com/ZeroBot-net/tg-bot-api/issues).
+2. Browse through [StackOverflow](https://stackoverflow.com/search?q=telegram+nodejs) and other similar platforms.
+3. Should you open your issue, ensure you use the English language for
+   the wider target audience.
+4. Be patient please.
+
+
+### Updating API Reference i.e. generating `doc/api.md`
+
+Run:
+
+```bash
+$ npm run doc
+```
+
+
+### Running tests
+
+Please read `test/README.md` for more information.
+
+
+### Transpiling ES2015 for older Node.js versions
+
+We use babel to transpile the code:
+
+```bash
+$ npm run build
+```
+
+[coc]:https://github.com/ZeroBot-net/tg-bot-api/blob/master/CODE_OF_CONDUCT.md
+[license]:https://github.com/ZeroBot-net/tg-bot-api/blob/master/LICENSE.md

package/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yago
+Copyright (c) 2016 GrandpaEJ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,130 @@
+<h1 align="center">Node.js Telegram Bot API</h1>
+
+<div align="center">
+
+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.3-00aced.svg?style=flat-square&logo=telegram)](https://core.telegram.org/bots/api)
+[![npm package](https://img.shields.io/npm/v/@zero-bot.net/tg-bot-api?logo=npm&style=flat-square)](https://www.npmjs.org/package/@zero-bot.net/tg-bot-api)
+[![Build Status](https://img.shields.io/travis/ZeroBot-net/tg-bot-api/master?style=flat-square&logo=travis)](https://travis-ci.org/ZeroBot-net/tg-bot-api)
+[![Coverage Status](https://img.shields.io/codecov/c/github/ZeroBot-net/tg-bot-api?style=flat-square&logo=codecov)](https://codecov.io/gh/ZeroBot-net/tg-bot-api)
+
+[![https://telegram.me/node_telegram_bot_api](https://img.shields.io/badge/💬%20Telegram-Channel-blue.svg?style=flat-square)](https://telegram.me/node_telegram_bot_api)
+[![https://t.me/+nc3A9Hs1S81mYzdk](https://img.shields.io/badge/💬%20Telegram-Group-blue.svg?style=flat-square)](https://t.me/+nc3A9Hs1S81mYzdk)
+[![https://telegram.me/Yago_Perez](https://img.shields.io/badge/💬%20Telegram-Yago_Perez-blue.svg?style=flat-square)](https://telegram.me/Yago_Perez)
+
+</div>
+
+## 📦 Install
+
+```sh
+npm i @zero-bot.net/tg-bot-api
+```
+
+<br/>
+
+> ✍️ **Note:** If you use Typescript you can install this package that contains type definitions for this library
+>```sh
+>npm install --save-dev @types/@zero-bot.net/tg-bot-api
+>```
+
+## 🚀 Usage
+
+```js
+const TelegramBot = require('@zero-bot.net/tg-bot-api');
+
+// replace the value below with the Telegram token you receive from @BotFather
+const token = 'YOUR_TELEGRAM_BOT_TOKEN';
+
+// Create a bot that uses 'polling' to fetch new updates
+const bot = new TelegramBot(token, {polling: true});
+
+// Matches "/echo [whatever]"
+bot.onText(/\/echo (.+)/, (msg, match) => {
+  // 'msg' is the received Message from Telegram
+  // 'match' is the result of executing the regexp above on the text content
+  // of the message
+
+  const chatId = msg.chat.id;
+  const resp = match[1]; // the captured "whatever"
+
+  // send back the matched "whatever" to the chat
+  bot.sendMessage(chatId, resp);
+});
+
+// Listen for any kind of message. There are different kinds of
+// messages.
+bot.on('message', (msg) => {
+  const chatId = msg.chat.id;
+
+  // send a message to the chat acknowledging receipt of their message
+  bot.sendMessage(chatId, 'Received your message');
+});
+```
+
+## 📚 Documentation
+
+* [Usage][usage]
+* [Examples][examples]
+* [Tutorials][tutorials]
+* [Help Information][help]
+* API Reference: ([api-release](../master/doc/api.md) / [development][api-dev] / [experimental][api-experimental])
+* [Contributing to the Project][contributing]
+* [Experimental Features][experimental]
+
+_**Note**: Development is done against the **development** branch.
+Code for the latest release resides on the **master** branch.
+Experimental features reside on the **experimental** branch._
+
+
+## 💭 Community
+
+We thank all the developers in the Open-Source community who continuously
+take their time and effort in advancing this project.
+See our [list of contributors][contributors].
+
+We have a [Telegram channel][tg-channel] where we post updates on
+the Project. Head over and subscribe!
+
+We also have a [Telegram  group][tg-group] to discuss issues related to this library.
+
+Some things built using this library that might interest you:
+
+* [tgfancy](https://github.com/GochoMugo/tgfancy): A fancy, higher-level wrapper for Telegram Bot API
+* [@zero-bot.net/tg-bot-api-middleware](https://github.com/idchlife/@zero-bot.net/tg-bot-api-middleware): Middleware for @zero-bot.net/tg-bot-api
+* [teleirc](https://github.com/FruitieX/teleirc): A simple Telegram ↔ IRC gateway
+* [bot-brother](https://github.com/SerjoPepper/bot-brother): Node.js library to help you easily create telegram bots
+* [redbot](https://github.com/guidone/node-red-contrib-chatbot): A Node-RED plugin to create telegram bots visually
+* [node-telegram-keyboard-wrapper](https://github.com/alexandercerutti/node-telegram-keyboard-wrapper): A wrapper to improve keyboards structures creation through a more easy-to-see way (supports Inline Keyboards, Reply Keyboard, Remove Keyboard and Force Reply)
+* [beetube-bot](https://github.com/kodjunkie/beetube-bot): A telegram bot for music, videos, movies, EDM tracks, torrent downloads, files and more.
+* [telegram-inline-calendar](https://github.com/VDS13/telegram-inline-calendar): Date and time picker and inline calendar for Node.js telegram bots.
+* [telegram-captcha](https://github.com/VDS13/telegram-captcha): Telegram bot to protect Telegram groups from automatic bots.
+
+
+## 👥 Contributors
+
+<p align="center">
+  <a href="https://github.com/ZeroBot-net/tg-bot-api/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=ZeroBot-net/tg-bot-api" />
+  </a>
+</p>
+
+## License
+
+**The MIT License (MIT)**
+
+Copyright © 2019 Yago
+
+[usage]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/doc/usage.md
+[examples]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/examples
+[help]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/doc/help.md
+[tutorials]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/doc/tutorials.md
+[api-dev]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/doc/api.md
+[api-release]:https://github.com/ZeroBot-net/tg-bot-api/tree/release/doc/api.md
+[api-experimental]:https://github.com/ZeroBot-net/tg-bot-api/tree/experimental/doc/api.md
+[contributing]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/CONTRIBUTING.md
+[contributors]:https://github.com/ZeroBot-net/tg-bot-api/graphs/contributors
+[experimental]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/doc/experimental.md
+[tg-channel]:https://telegram.me/node_telegram_bot_api
+[tg-group]:https://t.me/+nc3A9Hs1S81mYzdk

package/doc/api.hbs

@@ -0,0 +1,19 @@
+# API Reference
+
+**Note:** If you are looking for available [events](usage.md#events) or usage of api, please refer [`usage.md`](usage.md).
+
+{{#class name="TelegramBot"~}}
+{{>header~}}
+{{>body~}}
+{{>member-index~}}
+{{>members~}}
+{{/class}}
+* * *
+
+
+[usage-sending-files-performance]:https://github.com/ZeroBot-net/tg-bot-api/tree/master/doc/usage.md#sending-files-performance
+[setWebHook-v0.25.0]:https://github.com/ZeroBot-net/tg-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#telegrambotsetwebhookurl-cert
+[getUpdates-v0.25.0]:https://github.com/ZeroBot-net/tg-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUpdates
+[getUserProfilePhotos-v0.25.0]:https://github.com/ZeroBot-net/tg-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
+[answerCallbackQuery-v0.27.1]:https://github.com/ZeroBot-net/tg-bot-api/blob/v0.27.1/doc/api.md#TelegramBot+answerCallbackQuery
+[answerCallbackQuery-v0.29.0]:https://github.com/ZeroBot-net/tg-bot-api/blob/v0.29.0/doc/api.md#TelegramBot+answerCallbackQuery