https://github.com/gramiojs/types
Code-generated and Auto-published Telegram Bot API types
https://github.com/gramiojs/types
api auto-published bot cicd code-generated telegram telegram-bot-api types
Last synced: 25 days ago
JSON representation
Code-generated and Auto-published Telegram Bot API types
- Host: GitHub
- URL: https://github.com/gramiojs/types
- Owner: gramiojs
- License: mit
- Created: 2024-01-05T15:07:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-13T12:35:56.000Z (3 months ago)
- Last Synced: 2025-03-30T21:31:06.000Z (about 1 month ago)
- Topics: api, auto-published, bot, cicd, code-generated, telegram, telegram-bot-api, types
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@gramio/types
- Size: 278 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Code-generated and Auto-published Telegram Bot API types
[](https://core.telegram.org/bots/api)
[](https://www.npmjs.org/package/@gramio/types)
[](https://www.npmjs.org/package/@gramio/types)
[](https://jsr.io/@gramio/types)
[](https://jsr.io/@gramio/types)
### Versioning
8.1.x types are for 8.1 Telegram Bot API
## Usage as an [NPM package](https://www.npmjs.com/package/@gramio/types)
```ts
import type { APIMethods, APIMethodReturn } from "@gramio/types";
type SendMessageReturn = Awaited>;
// ^? type SendMessageReturn = TelegramMessage
type GetMeReturn = APIMethodReturn<"getMe">;
// ^? type GetMeReturn = TelegramUser
```
Please see [API Types References](https://tsdocs.dev/docs/@gramio/types)
### Auto-update package
This library is updated automatically to the latest version of the Telegram Bot API in case of changes thanks to CI CD!
If the github action failed, there are no changes in the Bot API
## Imports (after `@gramio/`)
- `index` - exports everything in the section
- `methods` - exports `APIMethods` which describes the api functions
- `objects` - exports objects with the `Telegram` prefix (for example [Update](https://core.telegram.org/bots/api/#update))
- `params` - exports params that are used in `methods` with `Params` postfix
### Write you own type-safe Telegram Bot API wrapper
```typescript
import type {
APIMethods,
APIMethodParams,
TelegramAPIResponse,
} from "@gramio/types";
const TBA_BASE_URL = "https://api.telegram.org/bot";
const TOKEN = "";
const api = new Proxy({} as APIMethods, {
get:
(_target: APIMethods, method: T) =>
async (params: APIMethodParams) => {
const response = await fetch(`${TBA_BASE_URL}${TOKEN}/${method}`, {
method: "POST",
headers: {
"Content-Type": "application/json",
},
body: JSON.stringify(params),
});
const data = (await response.json()) as TelegramAPIResponse;
if (!data.ok) throw new Error(`Some error occurred in ${method}`);
return data.result;
},
});
api.sendMessage({
chat_id: 1,
text: "message",
});
```
#### Usage with [`@gramio/keyboards`](https://github.com/gramiojs/keyboards)
```typescript
import { Keyboard } from "@gramio/keyboards";
// the code from the example above
api.sendMessage({
chat_id: 1,
text: "message with keyboard",
reply_markup: new Keyboard().text("button text"),
});
```
#### With File uploading support
[Documentation](https://gramio.dev/files/usage-without-gramio.html#write-you-own-type-safe-tba-api-wrapper-with-file-uploading-support)
## Generate types manually
Prerequire - [`rust`](https://www.rust-lang.org/)
1. Clone [this repo](https://github.com/gramiojs/types) and open it
```bash
git clone https://github.com/gramiojs/types.git
```
2. Clone [repo](https://github.com/ark0f/tg-bot-api) with Telegram Bot API schema generator
```bash
git clone https://github.com/ark0f/tg-bot-api.git
```
3. Run the JSON schema generator in the `cloned` folder
```bash
cd tg-bot-api && cargo run --package gh-pages-generator --bin gh-pages-generator -- dev && cd ..
```
4. Run types code-generation from the `root` of the project
```bash
bun generate
```
or, if you don't use `bun`, use `tsx`
```bash
npx tsx src/index.ts
```
5. Profit! Check out the types of Telegram Bot API in `out` folder!