grammy 1.25.1 → 1.26.0

package/README.md

@@ -10,7 +10,7 @@
 
 <!-- deno-fmt-ignore-start -->
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-7.5-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-7.6-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-)

package/out/composer.d.ts

@@ -1,4 +1,4 @@
-import { type CallbackQueryContext, type ChatTypeContext, type ChosenInlineResultContext, type CommandContext, Context, type GameQueryContext, type HearsContext, type InlineQueryContext, type MaybeArray, type ReactionContext, type StringWithSuggestions } from "./context.js";
+import { type CallbackQueryContext, type ChatTypeContext, type ChosenInlineResultContext, type CommandContext, Context, type GameQueryContext, type HearsContext, type InlineQueryContext, type MaybeArray, type PreCheckoutQueryContext, type ReactionContext, type ShippingQueryContext, type StringWithSuggestions } from "./context.js";
 import { type Filter, type FilterQuery } from "./filter.js";
 import { type Chat, type ReactionType, type ReactionTypeEmoji } from "./types.js";
 type MaybePromise<T> = T | Promise<T>;
@@ -412,10 +412,10 @@ export declare class Composer<C extends Context> implements MiddlewareObj<C> {
     inlineQuery(trigger: MaybeArray<string | RegExp>, ...middleware: Array<InlineQueryMiddleware<C>>): Composer<InlineQueryContext<C>>;
     /**
      * Registers middleware for the ChosenInlineResult by the given id or ids.
-     * ChosenInlineResult represents a result of an inline query that was
-     * chosen by the user and sent to their chat partner. Check out
-     * https://core.telegram.org/bots/api#choseninlineresult to read more
-     * about chosen inline results.
+     * ChosenInlineResult represents a result of an inline query that was chosen
+     * by the user and sent to their chat partner. Check out
+     * https://core.telegram.org/bots/api#choseninlineresult to read more about
+     * chosen inline results.
      *
      * ```ts
      * bot.chosenInlineResult('id', async ctx => {
@@ -428,6 +428,48 @@ export declare class Composer<C extends Context> implements MiddlewareObj<C> {
      * @param middleware The middleware to register
      */
     chosenInlineResult(resultId: MaybeArray<string | RegExp>, ...middleware: Array<ChosenInlineResultMiddleware<C>>): Composer<ChosenInlineResultContext<C>>;
+    /**
+     * Registers middleware for pre-checkout queries. Telegram sends a
+     * pre-checkout query to your bot whenever a user has confirmed their
+     * payment and shipping details. You bot will then receive all information
+     * about the order and has to respond within 10 seconds with a confirmation
+     * of whether everything is alright (goods are available, etc.) and the bot
+     * is ready to proceed with the order. Check out
+     * https://core.telegram.org/bots/api#precheckoutquery to read more about
+     * pre-checkout queries.
+     *
+     * ```ts
+     * bot.preCheckoutQuery('invoice_payload', async ctx => {
+     *   // Answer the pre-checkout query, confer https://core.telegram.org/bots/api#answerprecheckoutquery
+     *   await ctx.answerPreCheckoutQuery( ... )
+     * })
+     * ```
+     *
+     * @param trigger The string to look for in the invoice payload
+     * @param middleware The middleware to register
+     */
+    preCheckoutQuery(trigger: MaybeArray<string | RegExp>, ...middleware: Array<PreCheckoutQueryMiddleware<C>>): Composer<PreCheckoutQueryContext<C>>;
+    /**
+     * Registers middleware for shipping queries. If you sent an invoice
+     * requesting a shipping address and the parameter _is_flexible_ was
+     * specified, Telegram will send a shipping query to your bot whenever a
+     * user has confirmed their shipping details. You bot will then receive the
+     * shipping information and can respond with a confirmation of whether
+     * delivery to the specified address is possible. Check out
+     * https://core.telegram.org/bots/api#shippingquery to read more about
+     * shipping queries.
+     *
+     * ```ts
+     * bot.shippingQuery('invoice_payload', async ctx => {
+     *   // Answer the shipping query, confer https://core.telegram.org/bots/api#answershippingquery
+     *   await ctx.answerShippingQuery( ... )
+     * })
+     * ```
+     *
+     * @param trigger The string to look for in the invoice payload
+     * @param middleware The middleware to register
+     */
+    shippingQuery(trigger: MaybeArray<string | RegExp>, ...middleware: Array<ShippingQueryMiddleware<C>>): Composer<ShippingQueryContext<C>>;
     /**
      * > This is an advanced method of grammY.
      *
@@ -688,10 +730,28 @@ export type InlineQueryMiddleware<C extends Context> = Middleware<InlineQueryCon
  *
  * This helper type can be used to annotate middleware functions that are
  * defined in one place, so that they have the correct type when passed to
- * `bot.chosenInlineResult` in a different place. For instance, this allows for more
- * modular code where handlers are defined in separate files.
+ * `bot.chosenInlineResult` in a different place. For instance, this allows for
+ * more modular code where handlers are defined in separate files.
  */
 export type ChosenInlineResultMiddleware<C extends Context> = Middleware<ChosenInlineResultContext<C>>;
+/**
+ * Type of the middleware that can be passed to `bot.preCheckoutQuery`.
+ *
+ * This helper type can be used to annotate middleware functions that are
+ * defined in one place, so that they have the correct type when passed to
+ * `bot.preCheckoutQuery` in a different place. For instance, this allows for
+ * more modular code where handlers are defined in separate files.
+ */
+export type PreCheckoutQueryMiddleware<C extends Context> = Middleware<PreCheckoutQueryContext<C>>;
+/**
+ * Type of the middleware that can be passed to `bot.shippingQuery`.
+ *
+ * This helper type can be used to annotate middleware functions that are
+ * defined in one place, so that they have the correct type when passed to
+ * `bot.shippingQuery` in a different place. For instance, this allows for more
+ * modular code where handlers are defined in separate files.
+ */
+export type ShippingQueryMiddleware<C extends Context> = Middleware<ShippingQueryContext<C>>;
 /**
  * Type of the middleware that can be passed to `bot.chatType`.
  *

package/out/composer.js

@@ -429,10 +429,10 @@ class Composer {
     }
     /**
      * Registers middleware for the ChosenInlineResult by the given id or ids.
-     * ChosenInlineResult represents a result of an inline query that was
-     * chosen by the user and sent to their chat partner. Check out
-     * https://core.telegram.org/bots/api#choseninlineresult to read more
-     * about chosen inline results.
+     * ChosenInlineResult represents a result of an inline query that was chosen
+     * by the user and sent to their chat partner. Check out
+     * https://core.telegram.org/bots/api#choseninlineresult to read more about
+     * chosen inline results.
      *
      * ```ts
      * bot.chosenInlineResult('id', async ctx => {
@@ -447,6 +447,52 @@ class Composer {
     chosenInlineResult(resultId, ...middleware) {
         return this.filter(context_js_1.Context.has.chosenInlineResult(resultId), ...middleware);
     }
+    /**
+     * Registers middleware for pre-checkout queries. Telegram sends a
+     * pre-checkout query to your bot whenever a user has confirmed their
+     * payment and shipping details. You bot will then receive all information
+     * about the order and has to respond within 10 seconds with a confirmation
+     * of whether everything is alright (goods are available, etc.) and the bot
+     * is ready to proceed with the order. Check out
+     * https://core.telegram.org/bots/api#precheckoutquery to read more about
+     * pre-checkout queries.
+     *
+     * ```ts
+     * bot.preCheckoutQuery('invoice_payload', async ctx => {
+     *   // Answer the pre-checkout query, confer https://core.telegram.org/bots/api#answerprecheckoutquery
+     *   await ctx.answerPreCheckoutQuery( ... )
+     * })
+     * ```
+     *
+     * @param trigger The string to look for in the invoice payload
+     * @param middleware The middleware to register
+     */
+    preCheckoutQuery(trigger, ...middleware) {
+        return this.filter(context_js_1.Context.has.preCheckoutQuery(trigger), ...middleware);
+    }
+    /**
+     * Registers middleware for shipping queries. If you sent an invoice
+     * requesting a shipping address and the parameter _is_flexible_ was
+     * specified, Telegram will send a shipping query to your bot whenever a
+     * user has confirmed their shipping details. You bot will then receive the
+     * shipping information and can respond with a confirmation of whether
+     * delivery to the specified address is possible. Check out
+     * https://core.telegram.org/bots/api#shippingquery to read more about
+     * shipping queries.
+     *
+     * ```ts
+     * bot.shippingQuery('invoice_payload', async ctx => {
+     *   // Answer the shipping query, confer https://core.telegram.org/bots/api#answershippingquery
+     *   await ctx.answerShippingQuery( ... )
+     * })
+     * ```
+     *
+     * @param trigger The string to look for in the invoice payload
+     * @param middleware The middleware to register
+     */
+    shippingQuery(trigger, ...middleware) {
+        return this.filter(context_js_1.Context.has.shippingQuery(trigger), ...middleware);
+    }
     filter(predicate, ...middleware) {
         const composer = new Composer(...middleware);
         this.branch(predicate, composer, pass);

package/out/context.d.ts

@@ -1,7 +1,7 @@
 import { type Api, type Other as OtherApi } from "./core/api.js";
 import { type Methods, type RawApi } from "./core/client.js";
 import { type Filter, type FilterCore, type FilterQuery } from "./filter.js";
-import { type Chat, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPollOption, type LabeledPrice, type Message, type MessageEntity, type PassportElementError, type ReactionType, type ReactionTypeEmoji, type Update, type User, type UserFromGetMe } from "./types.js";
+import { type Chat, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPaidMedia, type InputPollOption, type LabeledPrice, type Message, type MessageEntity, type PassportElementError, type ReactionType, type ReactionTypeEmoji, type Update, type User, type UserFromGetMe } from "./types.js";
 export type MaybeArray<T> = T | T[];
 export type StringWithSuggestions<S extends string> = (string & Record<never, never>) | S;
 type Other<M extends Methods<RawApi>, X extends string = never> = OtherApi<RawApi, M, X>;
@@ -34,9 +34,9 @@ interface StaticHas {
      */
     command<S extends string>(command: MaybeArray<StringWithSuggestions<S | "start" | "help" | "settings">>): <C extends Context>(ctx: C) => ctx is CommandContext<C>;
     /**
-     * Generates a predicate function that can test context
-     * objects for containing a message reaction update. This uses the same
-     * logic as `bot.reaction`.
+     * Generates a predicate function that can test context objects for
+     * containing a message reaction update. This uses the same logic as
+     * `bot.reaction`.
      *
      * @param reaction The reaction to test against
      */
@@ -82,6 +82,24 @@ interface StaticHas {
      * @param trigger The string or regex to match
      */
     chosenInlineResult(trigger: MaybeArray<string | RegExp>): <C extends Context>(ctx: C) => ctx is ChosenInlineResultContext<C>;
+    /**
+     * Generates a predicate function that can test context objects for
+     * containing the given pre-checkout query, or for the pre-checkout query
+     * payload to match the given regular expression. This uses the same logic
+     * as `bot.preCheckoutQuery`.
+     *
+     * @param trigger The string or regex to match
+     */
+    preCheckoutQuery(trigger: MaybeArray<string | RegExp>): <C extends Context>(ctx: C) => ctx is PreCheckoutQueryContext<C>;
+    /**
+     * Generates a predicate function that can test context objects for
+     * containing the given shipping query, or for the shipping query to match
+     * the given regular expression. This uses the same logic as
+     * `bot.shippingQuery`.
+     *
+     * @param trigger The string or regex to match
+     */
+    shippingQuery(trigger: MaybeArray<string | RegExp>): <C extends Context>(ctx: C) => ctx is ShippingQueryContext<C>;
 }
 /**
  * When your bot receives a message, Telegram sends an update object to your
@@ -248,11 +266,12 @@ export declare class Context implements RenamedUpdate {
      */
     get businessConnectionId(): string | undefined;
     /**
-     * Get entities and their text. Extracts the text from `ctx.msg.text` or `ctx.msg.caption`.
-     * Returns an empty array if one of `ctx.msg`, `ctx.msg.text`
-     * or `ctx.msg.entities` is undefined.
+     * Get entities and their text. Extracts the text from `ctx.msg.text` or
+     * `ctx.msg.caption`. Returns an empty array if one of `ctx.msg`,
+     * `ctx.msg.text` or `ctx.msg.entities` is undefined.
      *
-     * You can filter specific entity types by passing the `types` parameter. Example:
+     * You can filter specific entity types by passing the `types` parameter.
+     * Example:
      *
      * ```ts
      * ctx.entities() // Returns all entity types
@@ -400,13 +419,32 @@ export declare class Context implements RenamedUpdate {
      */
     hasInlineQuery(trigger: MaybeArray<string | RegExp>): this is InlineQueryContextCore;
     /**
-     * Returns `true` if this context object contains the chosen inline result, or
-     * if the contained chosen inline result matches the given regular expression. It
-     * returns `false` otherwise. This uses the same logic as `bot.chosenInlineResult`.
+     * Returns `true` if this context object contains the chosen inline result,
+     * or if the contained chosen inline result matches the given regular
+     * expression. It returns `false` otherwise. This uses the same logic as
+     * `bot.chosenInlineResult`.
      *
      * @param trigger The string or regex to match
      */
     hasChosenInlineResult(trigger: MaybeArray<string | RegExp>): this is ChosenInlineResultContextCore;
+    /**
+     * Returns `true` if this context object contains the given pre-checkout
+     * query, or if the contained pre-checkout query matches the given regular
+     * expression. It returns `false` otherwise. This uses the same logic as
+     * `bot.preCheckoutQuery`.
+     *
+     * @param trigger The string or regex to match
+     */
+    hasPreCheckoutQuery(trigger: MaybeArray<string | RegExp>): this is PreCheckoutQueryContextCore;
+    /**
+     * Returns `true` if this context object contains the given shipping query,
+     * or if the contained shipping query matches the given regular expression.
+     * It returns `false` otherwise. This uses the same logic as
+     * `bot.shippingQuery`.
+     *
+     * @param trigger The string or regex to match
+     */
+    hasShippingQuery(trigger: MaybeArray<string | RegExp>): this is ShippingQueryContextCore;
     /**
      * Context-aware alias for `api.sendMessage`. Use this method to send text messages. On success, the sent Message is returned.
      *
@@ -439,7 +477,7 @@ export declare class Context implements RenamedUpdate {
      */
     forwardMessages(chat_id: number | string, message_ids: number[], other?: Other<"forwardMessages", "chat_id" | "from_chat_id" | "message_ids">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").MessageId[]>;
     /**
-     * Context-aware alias for `api.copyMessage`. Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
+     * Context-aware alias for `api.copyMessage`. Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param other Optional remaining parameters, confer the official reference below
@@ -449,7 +487,7 @@ export declare class Context implements RenamedUpdate {
      */
     copyMessage(chat_id: number | string, other?: Other<"copyMessage", "chat_id" | "from_chat_id" | "message_id">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").MessageId>;
     /**
-     * Context-aware alias for `api.copyMessages`.Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
+     * Context-aware alias for `api.copyMessages`. Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param message_ids A list of 1-100 identifiers of messages in the current chat to copy. The identifiers must be specified in a strictly increasing order.
@@ -577,6 +615,17 @@ export declare class Context implements RenamedUpdate {
     stopMessageLiveLocation(other?: Other<"stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & {
         location: import("@grammyjs/types/message.js").Location;
     })>;
+    /**
+     * Context-aware alias for `api.sendPaidMedia`. Use this method to send paid media to channel chats. On success, the sent Message is returned.
+     *
+     * @param star_count The number of Telegram Stars that must be paid to buy access to the media
+     * @param media An array describing the media to be sent; up to 10 items
+     * @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#sendpaidmedia
+     */
+    sendPaidMedia(star_count: number, media: InputPaidMedia[], other?: Other<"sendPaidMedia", "chat_id" | "star_count" | "media">, signal?: AbortSignal): Promise<Message.PaidMediaMessage>;
     /**
      * Context-aware alias for `api.sendVenue`. Use this method to send information about a venue. On success, the sent Message is returned.
      *
@@ -1395,6 +1444,30 @@ type ChosenInlineResultContextCore = FilterCore<"chosen_inline_result">;
  * in separate files and still have the correct types.
  */
 export type ChosenInlineResultContext<C extends Context> = Filter<NarrowMatch<C, string | RegExpMatchArray>, "chosen_inline_result">;
+type PreCheckoutQueryContextCore = FilterCore<"pre_checkout_query">;
+/**
+ * Type of the context object that is available inside the handlers for
+ * `bot.preCheckoutQuery`.
+ *
+ * This helper type can be used to narrow down context objects the same way how
+ * annotate `bot.preCheckoutQuery` does it. This allows you to context objects in
+ * middleware that is not directly passed to `bot.preCheckoutQuery`, hence not
+ * inferring the correct type automatically. That way, handlers can be defined
+ * in separate files and still have the correct types.
+ */
+export type PreCheckoutQueryContext<C extends Context> = Filter<NarrowMatch<C, string | RegExpMatchArray>, "pre_checkout_query">;
+type ShippingQueryContextCore = FilterCore<"shipping_query">;
+/**
+ * Type of the context object that is available inside the handlers for
+ * `bot.shippingQuery`.
+ *
+ * This helper type can be used to narrow down context objects the same way how
+ * annotate `bot.shippingQuery` does it. This allows you to context objects in
+ * middleware that is not directly passed to `bot.shippingQuery`, hence not
+ * inferring the correct type automatically. That way, handlers can be defined
+ * in separate files and still have the correct types.
+ */
+export type ShippingQueryContext<C extends Context> = Filter<NarrowMatch<C, string | RegExpMatchArray>, "shipping_query">;
 type ChatTypeContextCore<T extends Chat["type"]> = Record<"update", ChatTypeUpdate<T>> & ChatType<T> & Record<"chatId", number> & ChatFrom<T> & ChatTypeRecord<"msg", T> & AliasProps<ChatTypeUpdate<T>>;
 /**
  * Type of the context object that is available inside the handlers for

package/out/context.js

@@ -151,6 +151,18 @@ const checker = {
         return (ctx) => hasChosenInlineResult(ctx) &&
             match(ctx, ctx.chosenInlineResult.result_id, trg);
     },
+    preCheckoutQuery(trigger) {
+        const hasPreCheckoutQuery = checker.filterQuery("pre_checkout_query");
+        const trg = triggerFn(trigger);
+        return (ctx) => hasPreCheckoutQuery(ctx) &&
+            match(ctx, ctx.preCheckoutQuery.invoice_payload, trg);
+    },
+    shippingQuery(trigger) {
+        const hasShippingQuery = checker.filterQuery("shipping_query");
+        const trg = triggerFn(trigger);
+        return (ctx) => hasShippingQuery(ctx) &&
+            match(ctx, ctx.shippingQuery.invoice_payload, trg);
+    },
 };
 // === Context class
 /**
@@ -581,15 +593,38 @@ class Context {
         return Context.has.inlineQuery(trigger)(this);
     }
     /**
-     * Returns `true` if this context object contains the chosen inline result, or
-     * if the contained chosen inline result matches the given regular expression. It
-     * returns `false` otherwise. This uses the same logic as `bot.chosenInlineResult`.
+     * Returns `true` if this context object contains the chosen inline result,
+     * or if the contained chosen inline result matches the given regular
+     * expression. It returns `false` otherwise. This uses the same logic as
+     * `bot.chosenInlineResult`.
      *
      * @param trigger The string or regex to match
      */
     hasChosenInlineResult(trigger) {
         return Context.has.chosenInlineResult(trigger)(this);
     }
+    /**
+     * Returns `true` if this context object contains the given pre-checkout
+     * query, or if the contained pre-checkout query matches the given regular
+     * expression. It returns `false` otherwise. This uses the same logic as
+     * `bot.preCheckoutQuery`.
+     *
+     * @param trigger The string or regex to match
+     */
+    hasPreCheckoutQuery(trigger) {
+        return Context.has.preCheckoutQuery(trigger)(this);
+    }
+    /**
+     * Returns `true` if this context object contains the given shipping query,
+     * or if the contained shipping query matches the given regular expression.
+     * It returns `false` otherwise. This uses the same logic as
+     * `bot.shippingQuery`.
+     *
+     * @param trigger The string or regex to match
+     */
+    hasShippingQuery(trigger) {
+        return Context.has.shippingQuery(trigger)(this);
+    }
     // API
     /**
      * Context-aware alias for `api.sendMessage`. Use this method to send text messages. On success, the sent Message is returned.
@@ -629,7 +664,7 @@ class Context {
         return this.api.forwardMessages(chat_id, orThrow(this.chatId, "forwardMessages"), message_ids, other, signal);
     }
     /**
-     * Context-aware alias for `api.copyMessage`. Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
+     * Context-aware alias for `api.copyMessage`. Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param other Optional remaining parameters, confer the official reference below
@@ -641,7 +676,7 @@ class Context {
         return this.api.copyMessage(chat_id, orThrow(this.chatId, "copyMessage"), orThrow(this.msgId, "copyMessage"), other, signal);
     }
     /**
-     * Context-aware alias for `api.copyMessages`.Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
+     * Context-aware alias for `api.copyMessages`. Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param message_ids A list of 1-100 identifiers of messages in the current chat to copy. The identifiers must be specified in a strictly increasing order.
@@ -795,6 +830,19 @@ class Context {
             ? this.api.stopMessageLiveLocationInline(inlineId, other)
             : this.api.stopMessageLiveLocation(orThrow(this.chatId, "stopMessageLiveLocation"), orThrow(this.msgId, "stopMessageLiveLocation"), other, signal);
     }
+    /**
+     * Context-aware alias for `api.sendPaidMedia`. Use this method to send paid media to channel chats. On success, the sent Message is returned.
+     *
+     * @param star_count The number of Telegram Stars that must be paid to buy access to the media
+     * @param media An array describing the media to be sent; up to 10 items
+     * @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#sendpaidmedia
+     */
+    sendPaidMedia(star_count, media, other, signal) {
+        return this.api.sendPaidMedia(orThrow(this.chatId, "sendPaidMedia"), star_count, media, other, signal);
+    }
     /**
      * Context-aware alias for `api.sendVenue`. Use this method to send information about a venue. On success, the sent Message is returned.
      *

package/out/core/api.d.ts

@@ -1,4 +1,4 @@
-import { type BotCommand, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPollOption, type InputSticker, type LabeledPrice, type MaskPosition, type PassportElementError, type ReactionType } from "../types.js";
+import { type BotCommand, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type InputPaidMedia, type InputPollOption, type InputSticker, type LabeledPrice, type MaskPosition, type PassportElementError, type ReactionType } from "../types.js";
 import { type ApiClientOptions, type Methods, type Payload, type RawApi, type Transformer, type TransformerConsumer, type WebhookReplyEnvelope } from "./client.js";
 /**
  * Helper type to derive remaining properties of a given API method call M,
@@ -179,7 +179,7 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     forwardMessages(chat_id: number | string, from_chat_id: number | string, message_ids: number[], other?: Other<R, "forwardMessages", "chat_id" | "from_chat_id" | "message_ids">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").MessageId[]>;
     /**
-     * Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
+     * Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param from_chat_id Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
@@ -191,7 +191,7 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     copyMessage(chat_id: number | string, from_chat_id: number | string, message_id: number, other?: Other<R, "copyMessage", "chat_id" | "from_chat_id" | "message_id">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").MessageId>;
     /**
-     * Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
+     * Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param from_chat_id Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
@@ -359,6 +359,18 @@ export declare class Api<R extends RawApi = RawApi> {
     stopMessageLiveLocationInline(inline_message_id: string, other?: Other<R, "stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal): Promise<true | (import("@grammyjs/types/update.js").Update.Edited & import("@grammyjs/types/message.js").Message.CommonMessage & {
         location: import("@grammyjs/types/message.js").Location;
     })>;
+    /**
+     * Use this method to send paid media to channel chats. On success, the sent Message is returned.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+     * @param star_count The number of Telegram Stars that must be paid to buy access to the media
+     * @param media An array describing the media to be sent; up to 10 items
+     * @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#sendpaidmedia
+     */
+    sendPaidMedia(chat_id: number | string, star_count: number, media: InputPaidMedia[], other?: Other<R, "sendPaidMedia", "chat_id" | "star_count" | "media">, signal?: AbortSignal): Promise<import("@grammyjs/types/message.js").Message.PaidMediaMessage>;
     /**
      * Use this method to send information about a venue. On success, the sent Message is returned.
      *

package/out/core/api.js

@@ -173,7 +173,7 @@ class Api {
         }, signal);
     }
     /**
-     * Use this method to copy messages of any kind. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
+     * Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param from_chat_id Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername)
@@ -187,7 +187,7 @@ class Api {
         return this.raw.copyMessage({ chat_id, from_chat_id, message_id, ...other }, signal);
     }
     /**
-     * Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
+     * Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param from_chat_id Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)
@@ -380,6 +380,20 @@ class Api {
     stopMessageLiveLocationInline(inline_message_id, other, signal) {
         return this.raw.stopMessageLiveLocation({ inline_message_id, ...other }, signal);
     }
+    /**
+     * Use this method to send paid media to channel chats. On success, the sent Message is returned.
+     *
+     * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
+     * @param star_count The number of Telegram Stars that must be paid to buy access to the media
+     * @param media An array describing the media to be sent; up to 10 items
+     * @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#sendpaidmedia
+     */
+    sendPaidMedia(chat_id, star_count, media, other, signal) {
+        return this.raw.sendPaidMedia({ chat_id, star_count, media, ...other }, signal);
+    }
     /**
      * Use this method to send information about a venue. On success, the sent Message is returned.
      *

package/out/filter.d.ts

@@ -91,6 +91,7 @@ declare const UPDATE_KEYS: {
         readonly poll: {};
         readonly venue: {};
         readonly location: {};
+        readonly paid_media: {};
         readonly entities: {
             readonly mention: {};
             readonly hashtag: {};
@@ -213,6 +214,7 @@ declare const UPDATE_KEYS: {
         readonly poll: {};
         readonly venue: {};
         readonly location: {};
+        readonly paid_media: {};
         readonly entities: {
             readonly mention: {};
             readonly hashtag: {};
@@ -303,6 +305,7 @@ declare const UPDATE_KEYS: {
         readonly poll: {};
         readonly venue: {};
         readonly location: {};
+        readonly paid_media: {};
         readonly entities: {
             readonly mention: {};
             readonly hashtag: {};
@@ -393,6 +396,7 @@ declare const UPDATE_KEYS: {
         readonly poll: {};
         readonly venue: {};
         readonly location: {};
+        readonly paid_media: {};
         readonly entities: {
             readonly mention: {};
             readonly hashtag: {};
@@ -519,6 +523,7 @@ declare const UPDATE_KEYS: {
         readonly poll: {};
         readonly venue: {};
         readonly location: {};
+        readonly paid_media: {};
         readonly entities: {
             readonly mention: {};
             readonly hashtag: {};
@@ -641,6 +646,7 @@ declare const UPDATE_KEYS: {
         readonly poll: {};
         readonly venue: {};
         readonly location: {};
+        readonly paid_media: {};
         readonly entities: {
             readonly mention: {};
             readonly hashtag: {};

package/out/filter.js

@@ -265,6 +265,7 @@ const COMMON_MESSAGE_KEYS = {
     poll: {},
     venue: {},
     location: {},
+    paid_media: {},
     entities: ENTITY_KEYS,
     caption_entities: ENTITY_KEYS,
     caption: {},

package/out/types.node.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { type ApiMethods as ApiMethodsF, type InputMedia as InputMediaF, type InputMediaAnimation as InputMediaAnimationF, type InputMediaAudio as InputMediaAudioF, type InputMediaDocument as InputMediaDocumentF, type InputMediaPhoto as InputMediaPhotoF, type InputMediaVideo as InputMediaVideoF, type InputSticker as InputStickerF, type Opts as OptsF } from "@grammyjs/types";
+import { type ApiMethods as ApiMethodsF, type InputMedia as InputMediaF, type InputMediaAnimation as InputMediaAnimationF, type InputMediaAudio as InputMediaAudioF, type InputMediaDocument as InputMediaDocumentF, type InputMediaPhoto as InputMediaPhotoF, type InputMediaVideo as InputMediaVideoF, type InputPaidMedia as InputPaidMediaF, type InputPaidMediaPhoto as InputPaidMediaPhotoF, type InputPaidMediaVideo as InputPaidMediaVideoF, type InputSticker as InputStickerF, type Opts as OptsF } from "@grammyjs/types";
 import { type ReadStream } from "fs";
 export * from "@grammyjs/types";
 /** A value, or a potentially async function supplying that value */
@@ -69,3 +69,11 @@ export type InputMediaAnimation = InputMediaAnimationF<InputFile>;
 export type InputMediaAudio = InputMediaAudioF<InputFile>;
 /** Represents a general file to be sent. */
 export type InputMediaDocument = InputMediaDocumentF<InputFile>;
+/** This object describes the paid media to be sent. Currently, it can be one of
+- InputPaidMediaPhoto
+- InputPaidMediaVideo */
+export type InputPaidMedia = InputPaidMediaF<InputFile>;
+/** The paid media to send is a photo. */
+export type InputPaidMediaPhoto = InputPaidMediaPhotoF<InputFile>;
+/** The paid media to send is a video. */
+export type InputPaidMediaVideo = InputPaidMediaVideoF<InputFile>;

package/out/web.mjs

@@ -210,6 +210,7 @@ const COMMON_MESSAGE_KEYS = {
     poll: {},
     venue: {},
     location: {},
+    paid_media: {},
     entities: ENTITY_KEYS,
     caption_entities: ENTITY_KEYS,
     caption: {},
@@ -471,6 +472,16 @@ const checker = {
         const hasChosenInlineResult = checker.filterQuery("chosen_inline_result");
         const trg = triggerFn(trigger);
         return (ctx)=>hasChosenInlineResult(ctx) && match(ctx, ctx.chosenInlineResult.result_id, trg);
+    },
+    preCheckoutQuery (trigger) {
+        const hasPreCheckoutQuery = checker.filterQuery("pre_checkout_query");
+        const trg = triggerFn(trigger);
+        return (ctx)=>hasPreCheckoutQuery(ctx) && match(ctx, ctx.preCheckoutQuery.invoice_payload, trg);
+    },
+    shippingQuery (trigger) {
+        const hasShippingQuery = checker.filterQuery("shipping_query");
+        const trg = triggerFn(trigger);
+        return (ctx)=>hasShippingQuery(ctx) && match(ctx, ctx.shippingQuery.invoice_payload, trg);
     }
 };
 class Context {
@@ -685,6 +696,12 @@ class Context {
     hasChosenInlineResult(trigger) {
         return Context.has.chosenInlineResult(trigger)(this);
     }
+    hasPreCheckoutQuery(trigger) {
+        return Context.has.preCheckoutQuery(trigger)(this);
+    }
+    hasShippingQuery(trigger) {
+        return Context.has.shippingQuery(trigger)(this);
+    }
     reply(text, other, signal) {
         return this.api.sendMessage(orThrow(this.chatId, "sendMessage"), text, {
             business_connection_id: this.businessConnectionId,
@@ -765,6 +782,9 @@ class Context {
         const inlineId = this.inlineMessageId;
         return inlineId !== undefined ? this.api.stopMessageLiveLocationInline(inlineId, other) : this.api.stopMessageLiveLocation(orThrow(this.chatId, "stopMessageLiveLocation"), orThrow(this.msgId, "stopMessageLiveLocation"), other, signal);
     }
+    sendPaidMedia(star_count, media, other, signal) {
+        return this.api.sendPaidMedia(orThrow(this.chatId, "sendPaidMedia"), star_count, media, other, signal);
+    }
     replyWithVenue(latitude, longitude, title, address, other, signal) {
         return this.api.sendVenue(orThrow(this.chatId, "sendVenue"), latitude, longitude, title, address, {
             business_connection_id: this.businessConnectionId,
@@ -1173,6 +1193,12 @@ class Composer {
     chosenInlineResult(resultId, ...middleware) {
         return this.filter(Context.has.chosenInlineResult(resultId), ...middleware);
     }
+    preCheckoutQuery(trigger, ...middleware) {
+        return this.filter(Context.has.preCheckoutQuery(trigger), ...middleware);
+    }
+    shippingQuery(trigger, ...middleware) {
+        return this.filter(Context.has.shippingQuery(trigger), ...middleware);
+    }
     filter(predicate, ...middleware) {
         const composer = new Composer(...middleware);
         this.branch(predicate, composer, pass);
@@ -2541,6 +2567,14 @@ class Api {
             ...other
         }, signal);
     }
+    sendPaidMedia(chat_id, star_count, media, other, signal) {
+        return this.raw.sendPaidMedia({
+            chat_id,
+            star_count,
+            media,
+            ...other
+        }, signal);
+    }
     sendVenue(chat_id, latitude, longitude, title, address, other, signal) {
         return this.raw.sendVenue({
             chat_id,

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "grammy",
     "description": "The Telegram Bot Framework.",
-    "version": "1.25.1",
+    "version": "1.26.0",
     "author": "KnorpelSenf",
     "license": "MIT",
     "engines": {
@@ -17,7 +17,7 @@
         "backport": "deno2node tsconfig.json"
     },
     "dependencies": {
-        "@grammyjs/types": "3.9.0",
+        "@grammyjs/types": "3.10.0",
         "abort-controller": "^3.0.0",
         "debug": "^4.3.4",
         "node-fetch": "^2.7.0"