sergeysova / telegram-typings Goto Github PK

View Code? Open in Web Editor NEW

40.0 4.0 9.0 1.05 MB

Flow, TypeScript, Rust types for Telegram Bots API

License: MIT License

JavaScript 29.82% Rust 70.18%

flowtype typescript javascript rust crate telegram telegram-bot

telegram-typings's Introduction

Telegram Bot API typings for Flow, TypeScript and Rust

This repository contains Telegram Bot API typings for Flow, TypeScript and Rust.

The types are automatically generated for all supported languages from the Telegram Bot API website.

Flow and TypeScript typings

See javascript/ folder.

Rust typings

See rust folder.

Contributing

Source code for the type generation lives under lib/ folder.

Setting up local development environment

To contribute to this project, you will need to have the following tools installed:

Rust
Node v8.x or higher
npm v5.7.1 or higher

Once these tools are installed, you can install the required dependencies:

npm install
cargo install rustfmt --version 0.9.0

Generating new typings

To generate new types, run the following:

npm run build

If the Telegram Bot API documentation has not changed, and you haven't done any changes to code, you should not get any diff.

telegram-typings's People

Contributors

Stargazers

Watchers

Forkers

valscion nessgor adizbek fazendaaa krineko pind0s knorpelsenf kuznetsovgm

telegram-typings's Issues

Parse unions

Example: https://core.telegram.org/bots/api#inlinequeryresult

Example: https://core.telegram.org/bots/api#sendsticker reply_markup

InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply

Thank you for this!

Hi!

I was just looking around whether anyone had created flowtype compatible types for Telegram Bot API and I stumbled upon this project.

It looks so amazing, and seems to work with the bot I'm currently writing!

Thank you for creating this ☺️. I'll see if I spot some strange cases with Flow and this package and see if I can contribute in any way

Have a great weekend!

SOVA-71 Upgrade typings to Bot API 4.4

https://core.telegram.org/bots/api

IssueHunt Summary

Backers (Total: $5.00)

sergeysova ($5.00)

Become a backer now!

Or submit a pull request to get the deposits!

Tips

Checkout the Issuehunt explorer to discover more funded issues.
Need some help from other developers? Add your repositories on IssueHunt to raise funds.

IssueHunt has been backed by the following sponsors. Become a sponsor

Parse `must be`

https://core.telegram.org/bots/api#inputmediavideo

Has field type with must be video.

Should create

export type InputMediaVideo = {
  type: 'video',
}

Refactor builders

Parse return value of methods

Need to add a new Passport chapter parser

Interface with parameters header in table.

https://core.telegram.org/bots/api#passportdata

Parse links in description

Links from description should be placed to comment into @see property.

Example: https://core.telegram.org/bots/api#forcereply

/**
  * Upon receiving a message with this object,
  * Telegram clients will display a reply interface to the user
  * (act as if the user has selected the bot‘s message and tapped ’Reply').
  * This can be extremely useful if you want to create user-friendly step-by-step
  * interfaces without having to sacrifice privacy mode.
  * @see https://core.telegram.org/bots#privacy-mode
  */
export type ForceReply = {
}

Parse methods

Methods has column named Parameters

Example: https://core.telegram.org/bots/api#answerinlinequery

Depends on #1

Move it to superbotjs org

Or this is not necessary?

Add rust crate

https://github.com/transform-it/transform-json-types

typescript не работает автодополнение

не работает автодополнение
и появляется ошибка при попытке считать свойство ctx.message.from
[ts] Type 'Message | undefined' has no property 'from' and no string index signature.

typescript 2.8.3
telegram-typings 3.6.0