abeya-tg-api 0.0.1-security → 1.0.0

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mugo@forfuture.co.ke. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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/yagop/node-telegram-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/yagop/node-telegram-bot-api/blob/master/CODE_OF_CONDUCT.md
+[license]:https://github.com/yagop/node-telegram-bot-api/blob/master/LICENSE.md

package/FORK_GUIDE.md

@@ -0,0 +1,223 @@
+# Guide to Publishing Your Custom Fork
+
+This guide will help you publish your custom fork of `node-telegram-bot-api` as `myown-node-telegram-bot-api`.
+
+## ✅ What's Already Done
+
+1. ✅ Cloned the original `node-telegram-bot-api` repository
+2. ✅ Updated `package.json` with your custom package name
+3. ✅ Updated `README.md` to reflect the fork
+4. ✅ Installed all dependencies
+
+## 📝 Next Steps to Customize
+
+### 1. Update Author Information
+
+Edit `package.json` and replace:
+```json
+"author": "Your Name <your-email@example.com>"
+```
+
+With your actual name and email.
+
+### 2. Update Repository URLs
+
+Edit `package.json` and replace `YOUR-USERNAME` with your actual GitHub username in these fields:
+- `repository.url`
+- `bugs.url`
+- `homepage`
+
+### 3. Make Your Custom Adaptations
+
+Now you can make any modifications you want to the code! The main source code is in:
+- `src/telegram.js` - Main bot class
+- `src/` - Other source files
+- `examples/` - Example usage files
+
+After making changes, build the project:
+```bash
+npm run build
+```
+
+## 🚀 Publishing to NPM
+
+### Step 1: Create an NPM Account
+
+If you don't have one, go to [npmjs.com](https://www.npmjs.com/signup) and create an account.
+
+### Step 2: Login to NPM
+
+```bash
+npm login
+```
+
+Enter your username, password, and email when prompted.
+
+### Step 3: Check Package Name Availability
+
+Before publishing, verify the name is available:
+```bash
+npm view myown-node-telegram-bot-api
+```
+
+If you get a 404 error, the name is available! If not, choose a different name.
+
+### Step 4: Build the Project
+
+```bash
+npm run build
+```
+
+### Step 5: Publish Your Package
+
+For the first time:
+```bash
+npm publish --access public
+```
+
+For subsequent updates:
+1. Update the version in `package.json` (following [semantic versioning](https://semver.org/))
+2. Run: `npm publish`
+
+## 🔄 Version Management
+
+When you make changes and want to publish updates:
+
+```bash
+# For bug fixes (1.0.0 -> 1.0.1)
+npm version patch
+
+# For new features (1.0.0 -> 1.1.0)
+npm version minor
+
+# For breaking changes (1.0.0 -> 2.0.0)
+npm version major
+
+# Then publish
+npm publish
+```
+
+## 🐙 GitHub Repository Setup
+
+### Step 1: Create a New GitHub Repository
+
+1. Go to [GitHub](https://github.com/new)
+2. Create a new repository named `myown-node-telegram-bot-api`
+3. Don't initialize with README (we already have one)
+
+### Step 2: Update Remote Origin
+
+```bash
+# Remove the old origin
+git remote remove origin
+
+# Add your new repository
+git remote add origin https://github.com/YOUR-USERNAME/myown-node-telegram-bot-api.git
+
+# Push to your repository
+git push -u origin master
+```
+
+## 🧪 Testing Your Fork Locally
+
+Before publishing, you can test your fork locally:
+
+### In this project:
+```bash
+npm run build
+npm test
+```
+
+### In another project:
+```bash
+# Link your package locally
+cd /path/to/your/fork
+npm link
+
+# In your test project
+cd /path/to/test-project
+npm link myown-node-telegram-bot-api
+```
+
+Then in your test project:
+```javascript
+const TelegramBot = require('myown-node-telegram-bot-api');
+// Test your bot...
+```
+
+## 📦 Using Your Published Package
+
+Once published, anyone (including you) can install it:
+
+```bash
+npm install myown-node-telegram-bot-api
+```
+
+Or with a specific version:
+```bash
+npm install myown-node-telegram-bot-api@1.0.0
+```
+
+## 🛠️ Development Workflow
+
+1. Make changes to the code in `src/`
+2. Build: `npm run build`
+3. Test: `npm test`
+4. Commit your changes: `git commit -am "Description of changes"`
+5. Update version: `npm version patch` (or minor/major)
+6. Push to GitHub: `git push && git push --tags`
+7. Publish to NPM: `npm publish`
+
+## ⚠️ Important Notes
+
+1. **Keep it legal**: The original package is MIT licensed, so you're free to fork and modify it. Just keep the original license and give credit to the original authors.
+
+2. **Choose a unique name**: If `myown-node-telegram-bot-api` is taken, choose another name. Try variations like:
+   - `your-name-telegram-bot-api`
+   - `custom-telegram-bot-api`
+   - `enhanced-telegram-bot-api`
+
+3. **Maintain your fork**: Consider periodically syncing with the original repository to get bug fixes and new features:
+   ```bash
+   # Add original repo as upstream
+   git remote add upstream https://github.com/yagop/node-telegram-bot-api.git
+   
+   # Fetch updates
+   git fetch upstream
+   
+   # Merge updates (be careful with conflicts)
+   git merge upstream/master
+   ```
+
+## 📚 Useful Commands
+
+```bash
+# Build the project
+npm run build
+
+# Run tests
+npm test
+
+# Run linter
+npm run eslint
+
+# Generate documentation
+npm run doc
+
+# Check what will be published
+npm pack --dry-run
+
+# View your published package
+npm view myown-node-telegram-bot-api
+```
+
+## 🎉 You're All Set!
+
+Your fork is now ready to be customized and published. Make your changes, test them thoroughly, and share your enhanced version with the world!
+
+## 📞 Support
+
+If you need help with the original API, refer to the [original documentation](https://github.com/yagop/node-telegram-bot-api).
+
+For NPM publishing issues, check out the [NPM documentation](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).
+

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yago
+
+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/PUBLISHING_CHECKLIST.md

@@ -0,0 +1,167 @@
+# Publishing Checklist ✓
+
+Use this checklist to ensure you've completed all necessary steps before publishing your fork.
+
+## 📝 Before You Start
+
+- [ ] Have a GitHub account
+- [ ] Have an NPM account (sign up at https://www.npmjs.com/signup)
+- [ ] Have a Telegram bot token from @BotFather (for testing)
+
+## 🔧 Personalization Steps
+
+- [ ] Update `package.json`:
+  - [ ] Change author name and email
+  - [ ] Replace `YOUR-USERNAME` with your GitHub username (3 places)
+  - [ ] Verify package name is unique (run: `npm view myown-node-telegram-bot-api`)
+  
+- [ ] Test locally:
+  - [ ] Run `npm run build` successfully
+  - [ ] Run `npm test` (should pass)
+  - [ ] Test with `test-bot-example.js` (optional but recommended)
+
+## 🐙 GitHub Setup (Recommended)
+
+- [ ] Create new GitHub repository named `myown-node-telegram-bot-api`
+- [ ] Update git remote:
+  ```bash
+  git remote remove origin
+  git remote add origin https://github.com/YOUR-USERNAME/myown-node-telegram-bot-api.git
+  ```
+- [ ] Commit your changes:
+  ```bash
+  git add .
+  git commit -m "Initial commit: Custom fork of node-telegram-bot-api"
+  ```
+- [ ] Push to GitHub:
+  ```bash
+  git push -u origin master
+  ```
+
+## 📦 NPM Publishing Steps
+
+- [ ] Login to NPM:
+  ```bash
+  npm login
+  ```
+  
+- [ ] Verify you're logged in:
+  ```bash
+  npm whoami
+  ```
+  
+- [ ] Final build:
+  ```bash
+  npm run build
+  ```
+  
+- [ ] Publish:
+  ```bash
+  npm publish --access public
+  ```
+  
+- [ ] Verify publication:
+  ```bash
+  npm view myown-node-telegram-bot-api
+  ```
+
+## ✅ Post-Publishing
+
+- [ ] Test installation in a new project:
+  ```bash
+  mkdir test-install
+  cd test-install
+  npm init -y
+  npm install myown-node-telegram-bot-api
+  ```
+  
+- [ ] Create a simple test script to verify it works
+
+- [ ] Update your GitHub repository README if needed
+
+- [ ] Share your package! Tell others about it
+
+## 🔄 For Future Updates
+
+When you make changes and want to publish updates:
+
+- [ ] Make your code changes in `src/` directory
+- [ ] Build: `npm run build`
+- [ ] Test: `npm test`
+- [ ] Update version:
+  - [ ] `npm version patch` (for bug fixes)
+  - [ ] `npm version minor` (for new features)
+  - [ ] `npm version major` (for breaking changes)
+- [ ] Commit and push to GitHub:
+  ```bash
+  git push && git push --tags
+  ```
+- [ ] Publish: `npm publish`
+
+## 🎯 Quick Commands Reference
+
+```bash
+# Build project
+npm run build
+
+# Run tests
+npm test
+
+# Run linter
+npm run eslint
+
+# Check NPM login
+npm whoami
+
+# Check package details
+npm view myown-node-telegram-bot-api
+
+# Update patch version (1.0.0 -> 1.0.1)
+npm version patch
+
+# Publish
+npm publish --access public
+```
+
+## 🆘 Troubleshooting
+
+### Package name already taken?
+- Check availability: `npm view myown-node-telegram-bot-api`
+- Try alternative names:
+  - `your-name-telegram-bot-api`
+  - `custom-telegram-bot-api`
+  - `enhanced-telegram-bot-api`
+  - `your-username-tg-bot-api`
+
+### Not logged in to NPM?
+- Run: `npm login`
+- Enter username, password, and email
+- Verify: `npm whoami`
+
+### Build errors?
+- Make sure all dependencies are installed: `npm install`
+- Check for syntax errors in your changes
+- Try deleting `lib/` folder and rebuild: `npm run build`
+
+### Publishing errors?
+- Make sure you're logged in: `npm whoami`
+- Check package name is unique
+- Ensure version is updated (can't publish same version twice)
+- Verify package.json is valid JSON
+
+## 📚 Helpful Resources
+
+- NPM Documentation: https://docs.npmjs.com/
+- Semantic Versioning: https://semver.org/
+- Original Bot API: https://github.com/yagop/node-telegram-bot-api
+- Telegram Bot API Docs: https://core.telegram.org/bots/api
+
+---
+
+**Pro Tip**: Use the `publish-helper.ps1` script to automate many of these steps:
+```powershell
+.\publish-helper.ps1
+```
+
+Good luck with your custom fork! 🚀
+

package/QUICK_START.md

@@ -0,0 +1,96 @@
+# Quick Start - Your Custom Fork
+
+## ✅ Setup Complete!
+
+Your fork of `node-telegram-bot-api` is ready! Here's what's been done:
+
+### Files Modified:
+- ✅ `package.json` - Updated with new package name and version
+- ✅ `README.md` - Updated with installation instructions
+- ✅ Built the project successfully
+
+### Current Package Details:
+- **Package Name**: `myown-node-telegram-bot-api`
+- **Version**: `1.0.0`
+- **Description**: Telegram Bot API - Custom Fork with Personal Adaptations
+
+## 🚀 Quick Publishing Steps
+
+### 1. Personalize Your Fork
+```bash
+# Edit package.json and update:
+# - "author": "Your Name <your-email@example.com>"
+# - Replace "YOUR-USERNAME" in repository URLs with your GitHub username
+```
+
+### 2. Test Locally (Optional but Recommended)
+```bash
+npm test
+npm link
+```
+
+### 3. Create GitHub Repository
+1. Go to https://github.com/new
+2. Create repo: `myown-node-telegram-bot-api`
+3. Run these commands:
+```bash
+git remote remove origin
+git remote add origin https://github.com/YOUR-USERNAME/myown-node-telegram-bot-api.git
+git add .
+git commit -m "Initial fork with custom adaptations"
+git push -u origin master
+```
+
+### 4. Publish to NPM
+```bash
+# Login to NPM (first time only)
+npm login
+
+# Check if name is available
+npm view myown-node-telegram-bot-api
+
+# Publish your package
+npm publish --access public
+```
+
+## 🎯 Now You Can Install It Anywhere!
+
+Once published, in any project:
+```bash
+npm install myown-node-telegram-bot-api
+```
+
+And use it:
+```javascript
+const TelegramBot = require('myown-node-telegram-bot-api');
+
+const token = 'YOUR_BOT_TOKEN';
+const bot = new TelegramBot(token, {polling: true});
+
+bot.onText(/\/start/, (msg) => {
+  bot.sendMessage(msg.chat.id, 'Hello from your custom fork!');
+});
+```
+
+## 📝 Making Custom Changes
+
+1. Edit files in `src/` directory
+2. Build: `npm run build`
+3. Test: `npm test`
+4. Update version: `npm version patch`
+5. Publish: `npm publish`
+
+## 📖 For More Details
+
+See `FORK_GUIDE.md` for comprehensive instructions on:
+- Version management
+- GitHub setup
+- Testing locally
+- Maintaining your fork
+- Best practices
+
+---
+
+**Need help?** Check out:
+- [NPM Publishing Guide](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry)
+- [Original node-telegram-bot-api Documentation](https://github.com/yagop/node-telegram-bot-api)