Telegen-TS

A simple and effective library that solely provides an implementation of the official Telegram Bot API.

• Current version: Bot API 7.10 (September 6, 2024)

📚 Docs

This module doesn't need much documentation as all the infos can be retrieved from the official telegram's docs: https://core.telegram.org/bots/api

However all the methods and types are well documented within the editor's linter 😉

💡 How does Telegen-TS works?

EASY! Telegen works by scraping all the important info relative to methods and types from the official API page (cited above). Then it autogenerates (telegram + autogen = telegen eheheh) two files:

• autogen-methods.ts contains the abstract class Methods, containing all the methods
  • TelegenTS extends Methods
  • all the methods simply call Methods.makeRequest(...) with the right parameters
  • makeRequest is an abstract method that is then implemented inTelegenTS
• autogen-types.ts containing TypeScript's interfaces
  • used in Methods for defining the types for parameters

Finally we have the most importante piece of the puzzle: translator.ts
This is the file that manages the scraping and the translation of the API

⚙️ Installation

npm install @xleddyl/telegen-ts

💻 Usage

First import @xleddyl/telegen-ts into your project

import { TelegenTS, Types } from '@xleddyl/telegen-ts'

const bot = new TelegenTS({ token: TOKEN })

And you are pretty much ready to go now. Here I just leave a small recap on what is exported from this library:

• TelegenTS is a class from which all the available methods can be called (alongside with the ones explained here)
• Types contains all the available types used as return values/function parameters (alongside with the ones explained here)
  • suitable for type casting in TypeScript
  • note: for return types manual inference is required 🤧 (read the docs to determine the return type of methods)

🧪 Examples

Get the latest message sent to the bot and respond with the same text

import { TelegenTS, Types } from '@xleddyl/telegen-ts'
const bot = new TelegenTS({ token: '1234567890:ASDFGHJKL' })

const update = (await bot.getUpdates()).pop() // .pop() to get only the last message
const msg = update.message
if (msg !== undefined) {
   await bot.sendMessage(msg.text, msg.chat.id, { reply_to_message_id: msg.message_id })
}

Very simple and dumb polling mechanism

import { TelegenTS, Types } from '@xleddyl/telegen-ts'
const bot = new TelegenTS({ token: '1234567890:ASDFGHJKL' })

async function poll(callbackfn: (updates: Types.Update[]) => Promise<void>) {
   let lastUpdateId = 0
   while (1) {
      try {
         const updates: Types.Update[] = await bot.getUpdates({ offset: lastUpdateId })
         if (updates === undefined) break
         if (updates.length === 0) continue
         lastUpdateId = updates[updates.length - 1].update_id + 1
         await callbackfn(updates)
      } catch (e) {
         console.log(e)
         return
      }
   }
}

async function handler(update: Update[]) {
   try {
      for (const update of updates) {
         const msg = update.message
         if (msg === undefined) continue
         await bot.sendMessage('ciao', msg.chat.id, { reply_to_message_id: msg.message_id })
      }
   } catch (e) {
      console.log(e)
   }
}

poll(handler)

Sending a media file

If you want you can send files whenever the API specifies that the method accepts an InputFile type as parameter. To do so please use fs.createReadStream(path) (I've not tested other methods for uploading files so you'll need to experiment)

import * as fs from 'fs'

const img = fs.createReadStream('./testimg.png')
await bot.sendPhoto(img, msg.chat.id)

And that's pretty much it!! 🥳
Happy botting! 🤖