npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@flancer32/teq-telegram-bot

v0.2.2

Published

A TeqFW plugin to build Telegram bots.

Downloads

12

Readme

@flancer32/teq-telegram-bot

A foundational npm package for building Telegram bots using grammY and @teqfw/di.

Overview

This package facilitates the creation of Telegram bots leveraging the grammY library (Habr post in Russian). Key features include:

  • Loading bot configuration (e.g., token) from external sources like a JSON file.
  • Supporting two operational modes:
    • Bot mode: Uses long polling.
    • Webhook server mode:
      • Operates over HTTP/HTTP2 behind a proxy.
      • Supports HTTPS as a standalone server.
  • Common setup tasks (e.g., registering commands at startup, setting up webhooks).
  • Extension points to add custom application logic.

Use Cases

Installation

To integrate the bot library in an npm application:

npm i @flancer32/teq-telegram-bot

Usage

The package includes several commands for managing bot modes and server operations:

./bin/tequila.mjs help
./bin/tequila.mjs tg-bot-start         # Start in long polling mode
./bin/tequila.mjs tg-bot-stop
./bin/tequila.mjs web-server-start     # Start in webhook mode
./bin/tequila.mjs web-server-stop

Configuration

Configure the main application with a local.json file in the ./cfg directory:

{
  "@flancer32/teq-telegram-bot": {
    "apiKeyTelegram": "YOUR_TELEGRAM_API_KEY"
  }
}

API

To implement custom bot logic, create a class that follows the Telegram_Bot_Back_Api_Setup interface. This class should initialize the grammY bot, set up middleware, and define bot commands and handlers.

Setup Replacement in @teqfw/di

Specify the custom setup class in the ./teqfw/json configuration file to override the default bot setup:

{
  "@teqfw/di": {
    "autoload": {},
    "replaces": {
      "back": {
        "Telegram_Bot_Back_Api_Setup": "YourApp_Back_Bot_Setup"
      }
    }
  }
}

Replace "YourApp_Back_Bot_Setup" with the fully qualified name of your custom setup class.