Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support Bot API 8.3 #757

Merged
merged 5 commits into from
Feb 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<!-- deno-fmt-ignore-start -->

[![Bot API](https://img.shields.io/badge/Bot%20API-8.2-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
[![Bot API](https://img.shields.io/badge/Bot%20API-8.3-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
[![Deno](https://shield.deno.dev/x/grammy)](https://deno.land/x/grammy)
[![npm](https://img.shields.io/npm/v/grammy?logo=npm&style=flat&labelColor=000&color=3b82f6)](https://www.npmjs.org/package/grammy)
[![All Contributors](https://img.shields.io/github/all-contributors/grammyjs/grammy?style=flat&labelColor=000&color=3b82f6)](#contributors-)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"backport": "deno2node tsconfig.json"
},
"dependencies": {
"@grammyjs/types": "3.18.0",
"@grammyjs/types": "3.19.0",
"abort-controller": "^3.0.0",
"debug": "^4.3.4",
"node-fetch": "^2.7.0"
Expand Down
28 changes: 25 additions & 3 deletions src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1538,7 +1538,7 @@ export class Context implements RenamedUpdate {
}

/**
* Context-aware alias for `api.setMessageReaction`. Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
* Context-aware alias for `api.setMessageReaction`. Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
*
* @param reaction A list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.
* @param other Optional remaining parameters, confer the official reference below
Expand Down Expand Up @@ -2822,7 +2822,7 @@ export class Context implements RenamedUpdate {
}

/**
* Context-aware alias for `api.sendGift`. Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success.
* Context-aware alias for `api.sendGift`. Sends a gift to the given user. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
*
* @param gift_id Identifier of the gift
* @param other Optional remaining parameters, confer the official reference below
Expand All @@ -2832,7 +2832,7 @@ export class Context implements RenamedUpdate {
*/
replyWithGift(
gift_id: string,
other?: Other<"sendGift", "user_id" | "gift_id">,
other?: Other<"sendGift", "user_id" | "chat_id" | "gift_id">,
signal?: AbortSignal,
) {
return this.api.sendGift(
Expand All @@ -2843,6 +2843,28 @@ export class Context implements RenamedUpdate {
);
}

/**
* Context-aware alias for `api.sendGift`. Sends a gift to the given channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
*
* @param gift_id Identifier of the gift
* @param other Optional remaining parameters, confer the official reference below
* @param signal Optional `AbortSignal` to cancel the request
*
* **Official reference:** https://core.telegram.org/bots/api#sendgift
*/
replyWithGiftToChannel(
gift_id: string,
other?: Other<"sendGift", "user_id" | "chat_id" | "gift_id">,
signal?: AbortSignal,
) {
return this.api.sendGiftToChannel(
orThrow(this.chat, "sendGift").id,
gift_id,
other,
signal,
);
}

/**
* Context-aware alias for `api.answerInlineQuery`. Use this method to send answers to an inline query. On success, True is returned.
* No more than 50 results per query are allowed.
Expand Down
29 changes: 24 additions & 5 deletions src/core/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -789,7 +789,7 @@ export class Api<R extends RawApi = RawApi> {
}

/**
* Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
* Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.
*
* @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
* @param message_id Identifier of the target message
Expand Down Expand Up @@ -2481,7 +2481,7 @@ export class Api<R extends RawApi = RawApi> {
}

/**
* Returns the list of gifts that can be sent by the bot to users. Requires no parameters. Returns a Gifts object.
* Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.
*
* @param signal Optional `AbortSignal` to cancel the request
*
Expand All @@ -2492,9 +2492,9 @@ export class Api<R extends RawApi = RawApi> {
}

/**
* Sends a gift to the given user. The gift can't be converted to Telegram Stars by the user. Returns True on success.
* Sends a gift to the given user. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
*
* @param user_id Unique identifier of the target user that will receive the gift
* @param user_id Unique identifier of the target user who will receive the gift
* @param gift_id Identifier of the gift
* @param other Optional remaining parameters, confer the official reference below
* @param signal Optional `AbortSignal` to cancel the request
Expand All @@ -2504,12 +2504,31 @@ export class Api<R extends RawApi = RawApi> {
sendGift(
user_id: number,
gift_id: string,
other?: Other<R, "sendGift", "user_id" | "gift_id">,
other?: Other<R, "sendGift", "user_id" | "chat_id" | "gift_id">,
signal?: AbortSignal,
) {
return this.raw.sendGift({ user_id, gift_id, ...other }, signal);
}

/**
* Sends a gift to the given channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.
*
* @param chat_id Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift
* @param gift_id Identifier of the gift
* @param other Optional remaining parameters, confer the official reference below
* @param signal Optional `AbortSignal` to cancel the request
*
* **Official reference:** https://core.telegram.org/bots/api#sendgift
*/
sendGiftToChannel(
chat_id: number | string,
gift_id: string,
other?: Other<R, "sendGift", "user_id" | "chat_id" | "gift_id">,
signal?: AbortSignal,
) {
return this.raw.sendGift({ chat_id, gift_id, ...other }, signal);
}

/**
* Use this method to send answers to an inline query. On success, True is returned.
* No more than 50 results per query are allowed.
Expand Down
4 changes: 2 additions & 2 deletions src/types.deno.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ import {
type InputPaidMediaVideo as InputPaidMediaVideoF,
type InputSticker as InputStickerF,
type Opts as OptsF,
} from "https://deno.land/x/grammy_types@v3.18.0/mod.ts";
} from "https://deno.land/x/grammy_types@v3.19.0/mod.ts";
import { debug as d, isDeno } from "./platform.deno.ts";

const debug = d("grammy:warn");

// === Export all API types
export * from "https://deno.land/x/grammy_types@v3.18.0/mod.ts";
export * from "https://deno.land/x/grammy_types@v3.19.0/mod.ts";

/** A value, or a potentially async function supplying that value */
type MaybeSupplier<T> = T | (() => T | Promise<T>);
Expand Down
4 changes: 2 additions & 2 deletions src/types.web.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ import {
type InputPaidMediaVideo as InputPaidMediaVideoF,
type InputSticker as InputStickerF,
type Opts as OptsF,
} from "https://deno.land/x/grammy_types@v3.18.0/mod.ts";
} from "https://deno.land/x/grammy_types@v3.19.0/mod.ts";

// === Export all API types
export * from "https://deno.land/x/grammy_types@v3.18.0/mod.ts";
export * from "https://deno.land/x/grammy_types@v3.19.0/mod.ts";

/** Something that looks like a URL. */
interface URLLike {
Expand Down