abeya-tg-api 0.0.1-security → 1.0.0

package/README.md

@@ -1,5 +1,131 @@
-# Security holding package
+<h1 align="center">Node.js Telegram Bot API - Custom Fork</h1>
 
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
+<div align="center">
 
-Please refer to www.npmjs.com/advisories?search=abeya-tg-api for more information.
+Node.js module to interact with the official [Telegram Bot API](https://core.telegram.org/bots/api).
+
+> **Note:** This is a custom fork of [node-telegram-bot-api](https://github.com/yagop/node-telegram-bot-api) with personal adaptations and enhancements.
+
+
+[![Bot API](https://img.shields.io/badge/Bot%20API-v.9.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)
+[![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)
+
+[![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/+_IC8j_b1wSFlZTVk](https://img.shields.io/badge/💬%20Telegram-Group-blue.svg?style=flat-square)](https://t.me/+_IC8j_b1wSFlZTVk)
+[![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 myown-node-telegram-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/node-telegram-bot-api
+>```
+
+## 🚀 Usage
+
+```js
+const TelegramBot = require('myown-node-telegram-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
+* [node-telegram-bot-api-middleware](https://github.com/idchlife/node-telegram-bot-api-middleware): Middleware for node-telegram-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/yagop/node-telegram-bot-api/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=yagop/node-telegram-bot-api" />
+  </a>
+</p>
+
+## License
+
+**The MIT License (MIT)**
+
+Copyright © 2019 Yago
+
+[usage]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/usage.md
+[examples]:https://github.com/yagop/node-telegram-bot-api/tree/master/examples
+[help]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/help.md
+[tutorials]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/tutorials.md
+[api-dev]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/api.md
+[api-release]:https://github.com/yagop/node-telegram-bot-api/tree/release/doc/api.md
+[api-experimental]:https://github.com/yagop/node-telegram-bot-api/tree/experimental/doc/api.md
+[contributing]:https://github.com/yagop/node-telegram-bot-api/tree/master/CONTRIBUTING.md
+[contributors]:https://github.com/yagop/node-telegram-bot-api/graphs/contributors
+[experimental]:https://github.com/yagop/node-telegram-bot-api/tree/master/doc/experimental.md
+[tg-channel]:https://telegram.me/node_telegram_bot_api
+[tg-group]:https://t.me/+nc3A9Hs1S81mYzdk

package/README_FORK_SETUP.md

@@ -0,0 +1,156 @@
+# 🎉 Your Fork is Ready!
+
+Congratulations! You've successfully forked `node-telegram-bot-api` and set it up as `myown-node-telegram-bot-api`.
+
+## 📁 What You Have Now
+
+Your workspace contains a complete, working fork of the Telegram Bot API library with:
+
+- ✅ **Modified package name**: `myown-node-telegram-bot-api`
+- ✅ **Updated documentation**: README.md reflects your fork
+- ✅ **Built successfully**: All source files compiled to `lib/` directory
+- ✅ **All dependencies installed**: Ready for development
+- ✅ **Example bot included**: `test-bot-example.js` for local testing
+
+## 📂 Project Structure
+
+```
+TG Bot Node/
+├── src/                    # Source code (edit these files)
+│   ├── telegram.js        # Main bot class
+│   ├── telegramPolling.js # Polling implementation
+│   ├── telegramWebHook.js # Webhook implementation
+│   └── ...
+├── lib/                    # Compiled code (auto-generated)
+├── examples/               # Example bots
+├── test/                   # Test files
+├── doc/                    # Documentation
+├── package.json           # Package configuration
+├── README.md              # Project readme
+├── FORK_GUIDE.md          # Comprehensive publishing guide
+├── QUICK_START.md         # Quick reference guide
+└── test-bot-example.js    # Simple example to test locally
+```
+
+## 🚀 Quick Actions
+
+### Test Locally Right Now
+```bash
+# 1. Open test-bot-example.js
+# 2. Replace 'YOUR_BOT_TOKEN' with your actual bot token
+# 3. Run:
+node test-bot-example.js
+```
+
+### Make Your First Customization
+```bash
+# 1. Edit a file in src/ directory (e.g., src/telegram.js)
+# 2. Build the project:
+npm run build
+
+# 3. Test it:
+node test-bot-example.js
+```
+
+### Prepare for Publishing
+
+1. **Update author info** in `package.json`:
+   ```json
+   "author": "Your Name <your@email.com>"
+   ```
+
+2. **Update GitHub URLs** in `package.json`:
+   - Replace `YOUR-USERNAME` with your GitHub username
+
+3. **Check package name availability**:
+   ```bash
+   npm view myown-node-telegram-bot-api
+   ```
+   If it returns 404, the name is available!
+
+4. **Create GitHub repository**:
+   - Go to https://github.com/new
+   - Name it: `myown-node-telegram-bot-api`
+   - Push your code
+
+5. **Publish to NPM**:
+   ```bash
+   npm login
+   npm publish --access public
+   ```
+
+## 🎯 Next Steps (Choose Your Path)
+
+### Path 1: Just Want to Test It? ⚡
+1. Get a bot token from [@BotFather](https://t.me/BotFather) on Telegram
+2. Edit `test-bot-example.js` with your token
+3. Run: `node test-bot-example.js`
+4. Message your bot on Telegram!
+
+### Path 2: Want to Customize First? 🛠️
+1. Explore the code in `src/` directory
+2. Make your changes
+3. Build: `npm run build`
+4. Test: `node test-bot-example.js`
+5. Repeat until satisfied!
+
+### Path 3: Ready to Publish? 📦
+1. Follow the "Prepare for Publishing" checklist above
+2. Read `QUICK_START.md` for step-by-step instructions
+3. See `FORK_GUIDE.md` for comprehensive details
+4. Publish to NPM
+5. Use it anywhere: `npm install myown-node-telegram-bot-api`
+
+## 💡 Pro Tips
+
+1. **Test before publishing**: Always test your changes locally first
+2. **Use semantic versioning**: 
+   - `npm version patch` for bug fixes (1.0.0 → 1.0.1)
+   - `npm version minor` for new features (1.0.0 → 1.1.0)
+   - `npm version major` for breaking changes (1.0.0 → 2.0.0)
+3. **Keep the original license**: The MIT license allows forking but requires attribution
+4. **Document your changes**: Update CHANGELOG.md when you make modifications
+
+## 📚 Helpful Files
+
+- **QUICK_START.md** - Fast reference for common tasks
+- **FORK_GUIDE.md** - Detailed guide for everything
+- **test-bot-example.js** - Simple example to test your fork
+- **examples/** - More advanced examples from original project
+- **doc/** - Full API documentation
+
+## 🆘 Common Issues
+
+### "Permission Denied" when publishing?
+- Make sure you're logged in: `npm login`
+- Check package name isn't taken: `npm view myown-node-telegram-bot-api`
+- Try a different package name if needed
+
+### Changes not working?
+- Did you run `npm run build` after editing src/ files?
+- The `lib/` directory contains the compiled code that actually runs
+
+### Want to sync with original repo?
+```bash
+git remote add upstream https://github.com/yagop/node-telegram-bot-api.git
+git fetch upstream
+git merge upstream/master
+```
+
+## 🎊 You're All Set!
+
+Your custom fork is ready to go! Whether you want to:
+- 🧪 Test it locally
+- 🎨 Customize it
+- 📦 Publish it to NPM
+- 🚀 Use it in your projects
+
+Everything is set up and ready. Good luck with your custom Telegram Bot API! 🤖
+
+---
+
+**Questions?** 
+- Original API Docs: https://github.com/yagop/node-telegram-bot-api
+- Telegram Bot API: https://core.telegram.org/bots/api
+- NPM Publishing: https://docs.npmjs.com/cli/publish
+

package/START_HERE.md

@@ -0,0 +1,231 @@
+# 🎉 START HERE - Your Custom Fork Setup Complete!
+
+## ✅ Setup Status: COMPLETE
+
+Your fork of `node-telegram-bot-api` is **fully configured** and ready to use!
+
+```
+Package Name: myown-node-telegram-bot-api
+Version: 1.0.0
+Status: ✓ Built Successfully
+Dependencies: ✓ Installed
+```
+
+---
+
+## 🚀 Quick Start (Choose One)
+
+### Option 1: Test It Right Now (5 minutes) ⚡
+
+1. Get a bot token from [@BotFather](https://t.me/BotFather) on Telegram
+2. Open `test-bot-example.js`
+3. Replace `'YOUR_BOT_TOKEN'` with your token
+4. Run:
+   ```bash
+   node test-bot-example.js
+   ```
+5. Message your bot on Telegram!
+
+### Option 2: Publish to NPM (15 minutes) 📦
+
+**Use the automated helper:**
+```powershell
+.\publish-helper.ps1
+```
+
+**Or follow the manual checklist:**
+- See `PUBLISHING_CHECKLIST.md` for step-by-step instructions
+
+### Option 3: Customize First (Your time) 🛠️
+
+1. Edit files in `src/` directory
+2. Build: `npm run build`
+3. Test: `node test-bot-example.js`
+4. Repeat!
+
+---
+
+## 📚 Documentation Files
+
+| File | Purpose |
+|------|---------|
+| 📖 **START_HERE.md** (this file) | Quick overview and next steps |
+| ⚡ **QUICK_START.md** | Fast reference guide |
+| 📘 **FORK_GUIDE.md** | Comprehensive publishing guide |
+| ✅ **PUBLISHING_CHECKLIST.md** | Step-by-step checklist |
+| 🤖 **test-bot-example.js** | Simple bot to test locally |
+| 🔧 **publish-helper.ps1** | Automated publishing assistant |
+| 📄 **README.md** | Main project documentation |
+
+---
+
+## 🎯 What You Need to Do
+
+### Required Before Publishing:
+
+1. **Update Author Information** (2 minutes)
+   - Open `package.json`
+   - Line 26: Change `"author": "Your Name <your-email@example.com>"`
+
+2. **Update GitHub Username** (1 minute)
+   - Open `package.json`
+   - Lines 68, 71, 73: Replace `YOUR-USERNAME` with your GitHub username
+
+3. **Verify Package Name** (30 seconds)
+   ```bash
+   npm view myown-node-telegram-bot-api
+   ```
+   - If it shows 404: ✓ Name is available!
+   - If it shows package info: ✗ Name is taken, choose another
+
+### Optional But Recommended:
+
+4. **Create GitHub Repository**
+   - Go to https://github.com/new
+   - Name: `myown-node-telegram-bot-api`
+   - Don't initialize with README
+
+5. **Test Locally**
+   - Follow "Option 1" above to test your bot
+
+---
+
+## 📦 Publishing Commands (When Ready)
+
+```bash
+# 1. Login to NPM (first time only)
+npm login
+
+# 2. Build the project
+npm run build
+
+# 3. Publish
+npm publish --access public
+
+# 4. Verify it worked
+npm view myown-node-telegram-bot-api
+```
+
+**After publishing, anyone can install it:**
+```bash
+npm install myown-node-telegram-bot-api
+```
+
+---
+
+## 🎨 Making Custom Changes
+
+### Edit Source Code:
+```
+src/
+├── telegram.js        ← Main bot class (start here!)
+├── telegramPolling.js ← Polling implementation
+├── telegramWebHook.js ← Webhook implementation
+└── utils.js           ← Utility functions
+```
+
+### After Each Change:
+```bash
+npm run build          # Compile src/ → lib/
+node test-bot-example.js  # Test your changes
+```
+
+---
+
+## 🔄 Update & Republish Workflow
+
+```bash
+# 1. Make changes in src/
+# 2. Build
+npm run build
+
+# 3. Test
+npm test
+
+# 4. Update version
+npm version patch    # 1.0.0 → 1.0.1 (bug fixes)
+# OR
+npm version minor    # 1.0.0 → 1.1.0 (new features)
+# OR  
+npm version major    # 1.0.0 → 2.0.0 (breaking changes)
+
+# 5. Publish
+npm publish
+
+# 6. Push to GitHub
+git push && git push --tags
+```
+
+---
+
+## ⚡ Quick Commands
+
+```bash
+# Build project
+npm run build
+
+# Run tests
+npm test
+
+# Lint code
+npm run eslint
+
+# Check NPM login
+npm whoami
+
+# Test bot locally
+node test-bot-example.js
+
+# Use automated helper
+.\publish-helper.ps1
+```
+
+---
+
+## 🆘 Need Help?
+
+### Quick References:
+- **Publishing questions?** → See `PUBLISHING_CHECKLIST.md`
+- **Detailed guide?** → See `FORK_GUIDE.md`
+- **Fast lookup?** → See `QUICK_START.md`
+
+### External Resources:
+- [NPM Publishing Guide](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry)
+- [Original node-telegram-bot-api Docs](https://github.com/yagop/node-telegram-bot-api)
+- [Telegram Bot API](https://core.telegram.org/bots/api)
+
+---
+
+## 💡 Pro Tips
+
+1. **Always test before publishing**: Run `npm test` and test with `test-bot-example.js`
+2. **Use semantic versioning**: Let users know what changed
+3. **Keep changelog updated**: Document your custom features
+4. **Credit the original**: Keep the MIT license and attribution
+
+---
+
+## 🎊 You're Ready to Go!
+
+Your custom fork is:
+- ✅ Configured with a unique package name
+- ✅ Built and working
+- ✅ Ready to customize
+- ✅ Ready to publish
+
+**Choose your path above and get started!** 🚀
+
+---
+
+## 📞 Support
+
+- **Original API Issues**: https://github.com/yagop/node-telegram-bot-api/issues
+- **NPM Help**: https://docs.npmjs.com/
+- **Telegram Bot API**: https://core.telegram.org/bots
+
+---
+
+<p align="center">
+  <strong>Happy Coding! 🤖</strong>
+</p>
+

package/bot.js

@@ -0,0 +1,36 @@
+// Import from your local fork
+const TelegramBot = require('node-telegram-bot-api');
+
+// Replace 'YOUR_TELEGRAM_BOT_TOKEN' with your actual bot token
+const token = process.env.TELEGRAM_BOT_TOKEN || 'YOUR_TELEGRAM_BOT_TOKEN';
+
+// Create a bot that uses 'polling' to fetch new updates
+const bot = new TelegramBot(token, { polling: true });
+
+// Listen for any kind of message
+bot.on('message', (msg) => {
+  const chatId = msg.chat.id;
+  const messageText = msg.text;
+
+  console.log(`Received message from ${chatId}: ${messageText}`);
+
+  // Send a message back
+  bot.sendMessage(chatId, `You said: ${messageText}`);
+});
+
+// Matches "/echo [whatever]"
+bot.onText(/\/echo (.+)/, (msg, match) => {
+  const chatId = msg.chat.id;
+  const resp = match[1]; // the captured "whatever"
+
+  bot.sendMessage(chatId, resp);
+});
+
+// Handle /start command
+bot.onText(/\/start/, (msg) => {
+  const chatId = msg.chat.id;
+  bot.sendMessage(chatId, 'Welcome! This bot is running on a custom fork of node-telegram-bot-api');
+});
+
+console.log('Bot is running...');
+

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/yagop/node-telegram-bot-api/tree/master/doc/usage.md#sending-files-performance
+[setWebHook-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#telegrambotsetwebhookurl-cert
+[getUpdates-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUpdates
+[getUserProfilePhotos-v0.25.0]:https://github.com/yagop/node-telegram-bot-api/tree/4e5a493cadfaad5589a8d79e55d9e0d103000ce4#TelegramBot+getUserProfilePhotos
+[answerCallbackQuery-v0.27.1]:https://github.com/yagop/node-telegram-bot-api/blob/v0.27.1/doc/api.md#TelegramBot+answerCallbackQuery
+[answerCallbackQuery-v0.29.0]:https://github.com/yagop/node-telegram-bot-api/blob/v0.29.0/doc/api.md#TelegramBot+answerCallbackQuery