tele-sdk-js

tele-sdk-js is a Vanilla JavaScript client SDK for the Telegram Bot API, designed to simplify the process of building bots for Telegram using TypeScript.

Installation

To install the package, use npm:

npm install tele-sdk-js

Features

• Easy-to-use TypeScript-based API.
• Supports all major Telegram Bot API methods.
• Provides examples and detailed documentation.

Basic Usage

Here's a simple example of how to use the SDK to send a message:

import { TelegramBot } from 'tele-sdk-js';

const bot = new TelegramBot('YOUR_BOT_TOKEN');

bot.sendMessage(chatId, 'Hello, World!');

For more examples, see the examples directory.

Framework Examples

The SDK can be used with various JavaScript frameworks. Here are some example implementations:

Vue.js 3

import { TelegramBot } from 'tele-sdk-js';

const bot = new TelegramBot('YOUR_BOT_TOKEN');

// In your Vue component
export default {
  setup() {
    const sendMessage = async () => {
      await bot.sendMessage({
        chat_id: 'YOUR_CHAT_ID',
        text: 'Hello from Vue!'
      });
    };
    return { sendMessage };
  }
}

See examples/vue/TelegramBot.vue for a complete chat interface implementation with:

• Text messaging
• Location sharing
• File uploading
• Modern UI with message history

React

import { TelegramBot } from 'tele-sdk-js';

const bot = new TelegramBot('YOUR_BOT_TOKEN');

// In your React component
const TelegramComponent: React.FC = () => {
  const sendMessage = async () => {
    await bot.sendMessage({
      chat_id: 'YOUR_CHAT_ID',
      text: 'Hello from React!'
    });
  };
  return <button onClick={sendMessage}>Send Message</button>;
};

See examples/react/TelegramBot.tsx for a full TypeScript implementation with:

• Message handling
• Location sharing
• File uploads
• Poll creation
• Styled components

Node.js

const { TelegramBot } = require('tele-sdk-js');

const bot = new TelegramBot('YOUR_BOT_TOKEN');

async function sendMessage() {
  await bot.sendMessage({
    chat_id: 'YOUR_CHAT_ID',
    text: 'Hello from Node.js!'
  });
}

See examples/nodejs/basic-bot.js for a complete example with:

• Basic message handling
• Location sharing
• Document sending
• Poll creation

Security Considerations

When using this SDK in web applications:

1. Never expose your bot token in frontend code
2. Create a backend API to handle bot operations
3. Use environment variables for sensitive data
4. Implement proper authentication for your bot endpoints

Requirements

• Node.js version 14 or higher.

Contribution

Contributions are always welcome! Please follow these steps:

1. Fork the repo
2. Create a new branch (git checkout -b <branch-name>)
   Please note that if you want to add a new method of Telegram Bot API (sendFile, sendMedia, sendAudio, etc.), your new creating branch name should be exactly like that.
3. Commit your changes (git commit -m 'Add new feature')
4. Push to the branch (git push origin <branch-name>)
5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.