grammy 1.25.1 → 1.25.2

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>;
@@ -428,6 +428,46 @@ 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.
      *
@@ -692,6 +732,24 @@ export type InlineQueryMiddleware<C extends Context> = Middleware<InlineQueryCon
  * 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

@@ -447,6 +447,50 @@ 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

@@ -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
@@ -407,6 +425,22 @@ export declare class Context implements RenamedUpdate {
      * @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.
      *
@@ -1395,6 +1429,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
 /**
@@ -590,6 +602,26 @@ class Context {
     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.

package/out/web.mjs

@@ -471,6 +471,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 +695,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,
@@ -1173,6 +1189,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);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "grammy",
     "description": "The Telegram Bot Framework.",
-    "version": "1.25.1",
+    "version": "1.25.2",
     "author": "KnorpelSenf",
     "license": "MIT",
     "engines": {