grammy 1.16.2 → 1.17.0

package/README.md

@@ -166,7 +166,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Asaku01"><img src="https://avatars.githubusercontent.com/u/29716396?v=4?s=100" width="100px;" alt="Asaku01"/><br /><sub><b>Asaku01</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Asaku01" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ppsimn"><img src="https://avatars.githubusercontent.com/u/88509883?v=4?s=100" width="100px;" alt="ppsimn"/><br /><sub><b>ppsimn</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Appsimn" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://satont.js.org/"><img src="https://avatars.githubusercontent.com/u/42675886?v=4?s=100" width="100px;" alt="Satont"/><br /><sub><b>Satont</b></sub></a><br /><a href="#plugin-Satont" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/grammyjs/grammY/commits?author=Satont" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/deptyped"><img src="https://avatars.githubusercontent.com/u/26162440?v=4?s=100" width="100px;" alt="deptyped"/><br /><sub><b>deptyped</b></sub></a><br /><a href="#example-deptyped" title="Examples">💡</a> <a href="https://github.com/grammyjs/grammY/commits?author=deptyped" title="Documentation">📖</a> <a href="#tutorial-deptyped" title="Tutorials">✅</a> <a href="https://github.com/grammyjs/grammY/issues?q=author%3Adeptyped" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/deptyped"><img src="https://avatars.githubusercontent.com/u/26162440?v=4?s=100" width="100px;" alt="deptyped"/><br /><sub><b>deptyped</b></sub></a><br /><a href="#example-deptyped" title="Examples">💡</a> <a href="https://github.com/grammyjs/grammY/commits?author=deptyped" title="Documentation">📖</a> <a href="#tutorial-deptyped" title="Tutorials">✅</a> <a href="https://github.com/grammyjs/grammY/issues?q=author%3Adeptyped" title="Bug reports">🐛</a> <a href="#translation-deptyped" title="Translation">🌍</a></td>
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/dzek69"><img src="https://avatars.githubusercontent.com/u/4936805?v=4?s=100" width="100px;" alt="Jacek Nowacki"/><br /><sub><b>Jacek Nowacki</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=dzek69" title="Documentation">📖</a> <a href="https://github.com/grammyjs/grammY/commits?author=dzek69" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/issues?q=author%3Adzek69" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Adzek69" title="Reviewed Pull Requests">👀</a> <a href="#ideas-dzek69" title="Ideas, Planning, & Feedback">🤔</a></td>
@@ -190,7 +190,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/taotie111"><img src="https://avatars.githubusercontent.com/u/44166322?v=4?s=100" width="100px;" alt="taotie111"/><br /><sub><b>taotie111</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=taotie111" title="Documentation">📖</a> <a href="#translation-taotie111" title="Translation">🌍</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/merlin-brandes-42328717a/"><img src="https://avatars.githubusercontent.com/u/14237330?v=4?s=100" width="100px;" alt="Merlin"/><br /><sub><b>Merlin</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=FatalMerlin" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://darve.sh"><img src="https://avatars.githubusercontent.com/u/22394081?v=4?s=100" width="100px;" alt="Darvesh"/><br /><sub><b>Darvesh</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Adarvesh" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=darvesh" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Adarvesh" title="Reviewed Pull Requests">👀</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="http://telegram.me/dcdunkan"><img src="https://avatars.githubusercontent.com/u/70066170?v=4?s=100" width="100px;" alt="dcdunkan"/><br /><sub><b>dcdunkan</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Adcdunkan" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=dcdunkan" title="Code">💻</a> <a href="#plugin-dcdunkan" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Adcdunkan" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/grammyjs/grammY/commits?author=dcdunkan" title="Documentation">📖</a> <a href="#ideas-dcdunkan" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-dcdunkan" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#tool-dcdunkan" title="Tools">🔧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://telegram.me/dcdunkan"><img src="https://avatars.githubusercontent.com/u/70066170?v=4?s=100" width="100px;" alt="dcdunkan"/><br /><sub><b>dcdunkan</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Adcdunkan" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=dcdunkan" title="Code">💻</a> <a href="#plugin-dcdunkan" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Adcdunkan" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/grammyjs/grammY/commits?author=dcdunkan" title="Documentation">📖</a> <a href="#ideas-dcdunkan" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-dcdunkan" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#tool-dcdunkan" title="Tools">🔧</a> <a href="#mentoring-dcdunkan" title="Mentoring">🧑‍🏫</a> <a href="#maintenance-dcdunkan" title="Maintenance">🚧</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://xuann.wang/"><img src="https://avatars.githubusercontent.com/u/44045911?v=4?s=100" width="100px;" alt="Kid"/><br /><sub><b>Kid</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=kidonng" title="Documentation">📖</a> <a href="#translation-kidonng" title="Translation">🌍</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://slava.fomin.io/"><img src="https://avatars.githubusercontent.com/u/1702725?v=4?s=100" width="100px;" alt="Slava Fomin II"/><br /><sub><b>Slava Fomin II</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aslavafomin" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=slavafomin" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://kikobeats.com/"><img src="https://avatars.githubusercontent.com/u/2096101?v=4?s=100" width="100px;" alt="Kiko Beats"/><br /><sub><b>Kiko Beats</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Kikobeats" title="Documentation">📖</a></td>
@@ -265,7 +265,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/amanape"><img src="https://avatars.githubusercontent.com/u/83104063?v=4?s=100" width="100px;" alt="Stephan Psaras"/><br /><sub><b>Stephan Psaras</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aamanape" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/shevernitskiy"><img src="https://avatars.githubusercontent.com/u/28886342?v=4?s=100" width="100px;" alt="shevernitskiy"/><br /><sub><b>shevernitskiy</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Ashevernitskiy" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Ashevernitskiy" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/mrmaster009"><img src="https://avatars.githubusercontent.com/u/81420490?v=4?s=100" width="100px;" alt="mrmaster009"/><br /><sub><b>mrmaster009</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=mrmaster009" title="Documentation">📖</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://lwjerri.dev/"><img src="https://avatars.githubusercontent.com/u/50290430?v=4?s=100" width="100px;" alt="Andrey Zontov"/><br /><sub><b>Andrey Zontov</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3ALWJerri" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=LWJerri" title="Code">💻</a> <a href="#question-LWJerri" title="Answering Questions">💬</a> <a href="#ideas-LWJerri" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://lwjerri.dev/"><img src="https://avatars.githubusercontent.com/u/50290430?v=4?s=100" width="100px;" alt="Andrey Zontov"/><br /><sub><b>Andrey Zontov</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3ALWJerri" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=LWJerri" title="Code">💻</a> <a href="#question-LWJerri" title="Answering Questions">💬</a> <a href="#ideas-LWJerri" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/commits?author=LWJerri" title="Documentation">📖</a> <a href="#translation-LWJerri" title="Translation">🌍</a></td>
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/AbbassAlmusawi"><img src="https://avatars.githubusercontent.com/u/73327881?v=4?s=100" width="100px;" alt="Abbass Al-Musawi"/><br /><sub><b>Abbass Al-Musawi</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=AbbassAlmusawi" title="Documentation">📖</a></td>
@@ -274,6 +274,11 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/MatyiFKBT"><img src="https://avatars.githubusercontent.com/u/6183867?v=4?s=100" width="100px;" alt="MatyiFKBT"/><br /><sub><b>MatyiFKBT</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=MatyiFKBT" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://chrisandrew.cl"><img src="https://avatars.githubusercontent.com/u/368831?v=4?s=100" width="100px;" alt="Chris Andrew C. L."/><br /><sub><b>Chris Andrew C. L.</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Achrisandrewcl" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=chrisandrewcl" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/kiyasov"><img src="https://avatars.githubusercontent.com/u/16527461?v=4?s=100" width="100px;" alt="Islam Kiiasov"/><br /><sub><b>Islam Kiiasov</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=kiyasov" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ssistoza"><img src="https://avatars.githubusercontent.com/u/17445445?v=4?s=100" width="100px;" alt="Shane Avery Sistoza"/><br /><sub><b>Shane Avery Sistoza</b></sub></a><br /><a href="#ideas-ssistoza" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/commits?author=ssistoza" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/commits?author=ssistoza" title="Tests">⚠️</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/MaicolAntali"><img src="https://avatars.githubusercontent.com/u/79454487?v=4?s=100" width="100px;" alt="Maicol"/><br /><sub><b>Maicol</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=MaicolAntali" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Nazar-Ant"><img src="https://avatars.githubusercontent.com/u/75927667?v=4?s=100" width="100px;" alt="Nazar Antoniuk"/><br /><sub><b>Nazar Antoniuk</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Nazar-Ant" title="Documentation">📖</a> <a href="#translation-Nazar-Ant" title="Translation">🌍</a> <a href="#maintenance-Nazar-Ant" title="Maintenance">🚧</a></td>
     </tr>
   </tbody>
 </table>

package/out/bot.d.ts

@@ -1,8 +1,10 @@
-import { BotError, Composer } from "./composer.js";
+import { BotError, Composer, type Middleware } from "./composer.js";
 import { Context } from "./context.js";
 import { Api } from "./core/api.js";
 import { type ApiClientOptions, type WebhookReplyEnvelope } from "./core/client.js";
+import { type Filter, type FilterQuery } from "./filter.js";
 import { type Update, type UserFromGetMe } from "./types.js";
+export declare const DEFAULT_UPDATE_TYPES: readonly ["message", "edited_message", "channel_post", "edited_channel_post", "inline_query", "chosen_inline_result", "callback_query", "shipping_query", "pre_checkout_query", "poll", "poll_answer", "my_chat_member", "chat_join_request"];
 /**
  * Options that can be specified when running the bot via simple long polling.
  */
@@ -117,6 +119,8 @@ export declare class Bot<C extends Context = Context, A extends Api = Api> exten
     private mePromise;
     private readonly clientConfig;
     private readonly ContextConstructor;
+    /** Used to log a warning if some update types are not in allowed_updates */
+    private observedUpdateTypes;
     /**
      * Holds the bot's error handler that is invoked whenever middleware throws
      * (rejects). If you set your own error handler via `bot.catch`, all that
@@ -155,6 +159,10 @@ export declare class Bot<C extends Context = Context, A extends Api = Api> exten
      */
     set botInfo(botInfo: UserFromGetMe);
     get botInfo(): UserFromGetMe;
+    /**
+     * @inheritdoc
+     */
+    on<Q extends FilterQuery>(filter: Q | Q[], ...middleware: Array<Middleware<Filter<C, Q>>>): Composer<Filter<C, Q>>;
     /**
      * Checks if the bot has been initialized. A bot is initialized if the bot
      * information is set. The bot information can either be set automatically

package/out/bot.js

@@ -1,15 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Bot = exports.BotError = void 0;
+exports.Bot = exports.BotError = exports.DEFAULT_UPDATE_TYPES = void 0;
 // deno-lint-ignore-file camelcase
 const composer_js_1 = require("./composer.js");
 Object.defineProperty(exports, "BotError", { enumerable: true, get: function () { return composer_js_1.BotError; } });
 const context_js_1 = require("./context.js");
 const api_js_1 = require("./core/api.js");
 const error_js_1 = require("./core/error.js");
+const filter_js_1 = require("./filter.js");
 const platform_node_js_1 = require("./platform.node.js");
 const debug = (0, platform_node_js_1.debug)("grammy:bot");
+const debugWarn = (0, platform_node_js_1.debug)("grammy:warn");
 const debugErr = (0, platform_node_js_1.debug)("grammy:error");
+exports.DEFAULT_UPDATE_TYPES = [
+    "message",
+    "edited_message",
+    "channel_post",
+    "edited_channel_post",
+    "inline_query",
+    "chosen_inline_result",
+    "callback_query",
+    "shipping_query",
+    "pre_checkout_query",
+    "poll",
+    "poll_answer",
+    "my_chat_member",
+    "chat_join_request",
+];
 /**
  * This is the single most important class of grammY. It represents your bot.
  *
@@ -53,6 +70,8 @@ class Bot extends composer_js_1.Composer {
         this.token = token;
         this.pollingRunning = false;
         this.lastTriedUpdateId = 0;
+        /** Used to log a warning if some update types are not in allowed_updates */
+        this.observedUpdateTypes = new Set();
         /**
          * Holds the bot's error handler that is invoked whenever middleware throws
          * (rejects). If you set your own error handler via `bot.catch`, all that
@@ -97,6 +116,15 @@ class Bot extends composer_js_1.Composer {
         }
         return this.me;
     }
+    /**
+     * @inheritdoc
+     */
+    on(filter, ...middleware) {
+        for (const [u] of (0, filter_js_1.parse)(filter).flatMap(filter_js_1.preprocess)) {
+            this.observedUpdateTypes.add(u);
+        }
+        return super.on(filter, ...middleware);
+    }
     /**
      * Checks if the bot has been initialized. A bot is initialized if the bot
      * information is set. The bot information can either be set automatically
@@ -256,20 +284,10 @@ a known bot info object.");
         // Bot was stopped during `onStart`
         if (!this.pollingRunning)
             return;
+        // Prevent common misuse that leads to missing updates
+        validateAllowedUpdates(this.observedUpdateTypes, options === null || options === void 0 ? void 0 : options.allowed_updates);
         // Prevent common misuse that causes memory leak
-        this.use = () => {
-            throw new Error(`It looks like you are registering more listeners \
-on your bot from within other listeners! This means that every time your bot \
-handles a message like this one, new listeners will be added. This list grows until \
-your machine crashes, so grammY throws this error to tell you that you should \
-probably do things a bit differently. If you're unsure how to resolve this problem, \
-you can ask in the group chat: https://telegram.me/grammyjs
-
-On the other hand, if you actually know what you're doing and you do need to install \
-further middleware while your bot is running, consider installing a composer \
-instance on your bot, and in turn augment the composer after the fact. This way, \
-you can circumvent this protection against memory leaks.`);
-        };
+        this.use = noUseFunction;
         // Start polling
         debug("Starting simple long polling");
         await this.loop(options);
@@ -327,10 +345,10 @@ you can circumvent this protection against memory leaks.`);
      * the bot is stopped.
      */
     async loop(options) {
-        var _a;
+        var _a, _b;
         const limit = options === null || options === void 0 ? void 0 : options.limit;
         const timeout = (_a = options === null || options === void 0 ? void 0 : options.timeout) !== null && _a !== void 0 ? _a : 30; // seconds
-        let allowed_updates = options === null || options === void 0 ? void 0 : options.allowed_updates;
+        let allowed_updates = (_b = options === null || options === void 0 ? void 0 : options.allowed_updates) !== null && _b !== void 0 ? _b : []; // reset to default if unspecified
         while (this.pollingRunning) {
             // fetch updates
             const updates = await this.fetchUpdates({ limit, timeout, allowed_updates });
@@ -503,4 +521,30 @@ async function sleep(seconds, signal) {
         signal === null || signal === void 0 ? void 0 : signal.removeEventListener("abort", abort);
     }
 }
+/**
+ * Takes a set of observed update types and a list of allowed updates and logs a
+ * warning in debug mode if some update types were observed that have not been
+ * allowed.
+ */
+function validateAllowedUpdates(updates, allowed = exports.DEFAULT_UPDATE_TYPES) {
+    const impossible = Array.from(updates).filter((u) => !allowed.includes(u));
+    if (impossible.length > 0) {
+        debugWarn(`You registered listeners for the following update types, \
+but you did not specify them in \`allowed_updates\` \
+so they may not be received: ${impossible.map((u) => `'${u}'`).join(", ")}`);
+    }
+}
+function noUseFunction() {
+    throw new Error(`It looks like you are registering more listeners \
+on your bot from within other listeners! This means that every time your bot \
+handles a message like this one, new listeners will be added. This list grows until \
+your machine crashes, so grammY throws this error to tell you that you should \
+probably do things a bit differently. If you're unsure how to resolve this problem, \
+you can ask in the group chat: https://telegram.me/grammyjs
+
+On the other hand, if you actually know what you're doing and you do need to install \
+further middleware while your bot is running, consider installing a composer \
+instance on your bot, and in turn augment the composer after the fact. This way, \
+you can circumvent this protection against memory leaks.`);
+}
 const shim_node_js_1 = require("./shim.node.js");

package/out/composer.d.ts

@@ -1,4 +1,4 @@
-import { type CallbackQueryContext, type ChatTypeContext, type CommandContext, Context, type GameQueryContext, type HearsContext, type InlineQueryContext, type MaybeArray, type StringWithSuggestions } from "./context.js";
+import { type CallbackQueryContext, type ChatTypeContext, type ChosenInlineResultContext, type CommandContext, Context, type GameQueryContext, type HearsContext, type InlineQueryContext, type MaybeArray, type StringWithSuggestions } from "./context.js";
 import { type Filter, type FilterQuery } from "./filter.js";
 import { type Chat } from "./types.js";
 type MaybePromise<T> = T | Promise<T>;
@@ -226,11 +226,11 @@ export declare class Composer<C extends Context> implements MiddlewareObj<C> {
      * via `ctx.match`.
      *
      * > **Did you know?** You can use deep linking
-     * > (https://core.telegram.org/bots/features#deep-linking) to let users start your
-     * > bot with a custom payload. As an example, send someone the link
-     * > https://t.me/name-of-your-bot?start=custom-payload and register a start
-     * > command handler on your bot with grammY. As soon as the user starts
-     * > your bot, you will receive `custom-payload` in the `ctx.match`
+     * > (https://core.telegram.org/bots/features#deep-linking) to let users
+     * > start your bot with a custom payload. As an example, send someone the
+     * > link https://t.me/name-of-your-bot?start=custom-payload and register a
+     * > start command handler on your bot with grammY. As soon as the user
+     * > starts your bot, you will receive `custom-payload` in the `ctx.match`
      * > property!
      * > ```ts
      * > bot.command('start', ctx => {
@@ -261,8 +261,8 @@ export declare class Composer<C extends Context> implements MiddlewareObj<C> {
      * // etc
      * ```
      *
-     * If you need more freedom matching your commands, check out the
-     * `command-filter` plugin.
+     * If you need more freedom matching your commands, check out the `commands`
+     * plugin.
      *
      * @param command The command to look for
      * @param middleware The middleware to register
@@ -383,6 +383,24 @@ export declare class Composer<C extends Context> implements MiddlewareObj<C> {
      * @param middleware The middleware to register
      */
     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.
+     *
+     * ```ts
+     * bot.chosenInlineResult('id', async ctx => {
+     *   const id = ctx.result_id;
+     *   // Your code
+     * })
+     * ```
+     *
+     * @param resultId An id or array of ids
+     * @param middleware The middleware to register
+     */
+    chosenInlineResult(resultId: MaybeArray<string | RegExp>, ...middleware: Array<ChosenInlineResultMiddleware<C>>): Composer<ChosenInlineResultContext<C>>;
     /**
      * > This is an advanced method of grammY.
      *
@@ -393,8 +411,8 @@ export declare class Composer<C extends Context> implements MiddlewareObj<C> {
      * skipped and the next middleware will be executed.
      *
      * This method has two signatures. The first one is straightforward, it is
-     * the one described above. Note that the predicate may be asynchronous, i.e.
-     * it can return a Promise of a boolean.
+     * the one described above. Note that the predicate may be asynchronous,
+     * i.e. it can return a Promise of a boolean.
      *
      * Alternatively, you can pass a function that has a type predicate as
      * return type. This will allow you to narrow down the context object. The
@@ -629,6 +647,15 @@ export type GameQueryMiddleware<C extends Context> = Middleware<GameQueryContext
  * modular code where handlers are defined in separate files.
  */
 export type InlineQueryMiddleware<C extends Context> = Middleware<InlineQueryContext<C>>;
+/**
+ * Type of the middleware that can be passed to `bot.chosenInlineResult`.
+ *
+ * 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.
+ */
+export type ChosenInlineResultMiddleware<C extends Context> = Middleware<ChosenInlineResultContext<C>>;
 /**
  * Type of the middleware that can be passed to `bot.chatType`.
  *

package/out/composer.js

@@ -231,11 +231,11 @@ class Composer {
      * via `ctx.match`.
      *
      * > **Did you know?** You can use deep linking
-     * > (https://core.telegram.org/bots/features#deep-linking) to let users start your
-     * > bot with a custom payload. As an example, send someone the link
-     * > https://t.me/name-of-your-bot?start=custom-payload and register a start
-     * > command handler on your bot with grammY. As soon as the user starts
-     * > your bot, you will receive `custom-payload` in the `ctx.match`
+     * > (https://core.telegram.org/bots/features#deep-linking) to let users
+     * > start your bot with a custom payload. As an example, send someone the
+     * > link https://t.me/name-of-your-bot?start=custom-payload and register a
+     * > start command handler on your bot with grammY. As soon as the user
+     * > starts your bot, you will receive `custom-payload` in the `ctx.match`
      * > property!
      * > ```ts
      * > bot.command('start', ctx => {
@@ -266,8 +266,8 @@ class Composer {
      * // etc
      * ```
      *
-     * If you need more freedom matching your commands, check out the
-     * `command-filter` plugin.
+     * If you need more freedom matching your commands, check out the `commands`
+     * plugin.
      *
      * @param command The command to look for
      * @param middleware The middleware to register
@@ -398,6 +398,26 @@ class Composer {
     inlineQuery(trigger, ...middleware) {
         return this.filter(context_js_1.Context.has.inlineQuery(trigger), ...middleware);
     }
+    /**
+     * 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.
+     *
+     * ```ts
+     * bot.chosenInlineResult('id', async ctx => {
+     *   const id = ctx.result_id;
+     *   // Your code
+     * })
+     * ```
+     *
+     * @param resultId An id or array of ids
+     * @param middleware The middleware to register
+     */
+    chosenInlineResult(resultId, ...middleware) {
+        return this.filter(context_js_1.Context.has.chosenInlineResult(resultId), ...middleware);
+    }
     filter(predicate, ...middleware) {
         const composer = new Composer(...middleware);
         this.branch(predicate, composer, pass);

package/out/context.d.ts

@@ -3,7 +3,7 @@ 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 LabeledPrice, type Message, type MessageEntity, type PassportElementError, type Update, type User, type UserFromGetMe } from "./types.js";
 export type MaybeArray<T> = T | T[];
-export type StringWithSuggestions<S extends string> = (string & {}) | S;
+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>;
 type SnakeToCamelCase<S extends string> = S extends `${infer L}_${infer R}` ? `${L}${Capitalize<SnakeToCamelCase<R>>}` : S;
 export type AliasProps<U> = {
@@ -66,6 +66,14 @@ interface StaticHas {
      * @param trigger The string or regex to match
      */
     inlineQuery(trigger: MaybeArray<string | RegExp>): <C extends Context>(ctx: C) => ctx is InlineQueryContext<C>;
+    /**
+     * Generates a predicate function that can test context objects for
+     * containing the chosen inline result, or for the chosen inline result to
+     * match the given regular expression.
+     *
+     * @param trigger The string or regex to match
+     */
+    chosenInlineResult(trigger: MaybeArray<string | RegExp>): <C extends Context>(ctx: C) => ctx is ChosenInlineResultContext<C>;
 }
 /**
  * When your bot receives a message, Telegram sends an update object to your
@@ -292,6 +300,14 @@ export declare class Context implements RenamedUpdate {
      * @param trigger The string or regex to match
      */
     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`.
+     *
+     * @param trigger The string or regex to match
+     */
+    hasChosenInlineResult(trigger: MaybeArray<string | RegExp>): this is ChosenInlineResultContextCore;
     /**
      * Context-aware alias for `api.sendMessage`. Use this method to send text messages. On success, the sent Message is returned.
      *
@@ -1181,6 +1197,18 @@ type InlineQueryContextCore = FilterCore<"inline_query">;
  * in separate files and still have the correct types.
  */
 export type InlineQueryContext<C extends Context> = Filter<C, "inline_query">;
+type ChosenInlineResultContextCore = FilterCore<"chosen_inline_result">;
+/**
+ * Type of the context object that is available inside the handlers for
+ * `bot.chosenInlineResult`.
+ *
+ * This helper type can be used to narrow down context objects the same way how
+ * annotate `bot.chosenInlineResult` does it. This allows you to context objects in
+ * middleware that is not directly passed to `bot.chosenInlineResult`, hence not
+ * inferring the correct type automatically. That way, handlers can be defined
+ * in separate files and still have the correct types.
+ */
+export type ChosenInlineResultContext<C extends Context> = Filter<C, "chosen_inline_result">;
 type ChatTypeContextCore<T extends Chat["type"]> = Record<"update", ChatTypeUpdate<T>> & ChatType<T> & ChatFrom<T> & ChatTypeRecord<"msg", T> & AliasProps<ChatTypeUpdate<T>>;
 /**
  * Type of the context object that is available inside the handlers for

package/out/context.js

@@ -81,6 +81,12 @@ const checker = {
         const trg = triggerFn(trigger);
         return (ctx) => hasInlineQuery(ctx) && match(ctx, ctx.inlineQuery.query, trg);
     },
+    chosenInlineResult(trigger) {
+        const hasChosenInlineResult = checker.filterQuery("chosen_inline_result");
+        const trg = triggerFn(trigger);
+        return (ctx) => hasChosenInlineResult(ctx) &&
+            match(ctx, ctx.chosenInlineResult.result_id, trg);
+    },
 };
 // === Context class
 /**
@@ -332,6 +338,16 @@ class Context {
     hasInlineQuery(trigger) {
         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`.
+     *
+     * @param trigger The string or regex to match
+     */
+    hasChosenInlineResult(trigger) {
+        return Context.has.chosenInlineResult(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/convenience/constants.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Contains lists of constants which are useful when working with the Bot API.
+ */
+export declare const API_CONSTANTS: Readonly<{
+    /**
+     * List of all available update types. Useful if you want to receive all
+     * updates from the Bot API, rather than just those that are delivered by
+     * default.
+     *
+     * The main use case for this is when you want to receive `chat_member`
+     * updates, as they need to be enabled first. Use it like so:
+     *
+     * ```ts
+     * // Built-in polling:
+     * bot.start({ allowed_updates: ALL_UPDATE_TYPES });
+     * // grammY runner:
+     * run(bot, { runner: { fetch: { allowed_updates: ALL_UPDATE_TYPES } } });
+     * // Webhooks:
+     * await bot.api.setWebhook(url, { allowed_updates: ALL_UPDATE_TYPES });
+     * ```
+     */
+    readonly ALL_UPDATE_TYPES: readonly ["message", "edited_message", "channel_post", "edited_channel_post", "inline_query", "chosen_inline_result", "callback_query", "shipping_query", "pre_checkout_query", "poll", "poll_answer", "my_chat_member", "chat_join_request", "chat_member"];
+    /**
+     * An object containing all available chat permissions. Useful if you want
+     * to lift restrictions from a user, as this action requires you to pass
+     * `true` for all permissions. Use it like so:
+     *
+     * ```ts
+     * // On `Bot`:
+     * await bot.api.restrictChatMember(chat_id, user_id, ALL_CHAT_PERMISSIONS);
+     * // On `Api`:
+     * await ctx.api.restrictChatMember(chat_id, user_id, ALL_CHAT_PERMISSIONS);
+     * // On `Context`:
+     * await ctx.restrictChatMember(user_id, ALL_CHAT_PERMISSIONS);
+     * await ctx.restrictAuthor(ALL_CHAT_PERMISSIONS);
+     * ```
+     */
+    readonly ALL_CHAT_PERMISSIONS: {
+        readonly can_send_messages: true;
+        readonly can_send_audios: true;
+        readonly can_send_documents: true;
+        readonly can_send_photos: true;
+        readonly can_send_videos: true;
+        readonly can_send_video_notes: true;
+        readonly can_send_voice_notes: true;
+        readonly can_send_polls: true;
+        readonly can_send_other_messages: true;
+        readonly can_add_web_page_previews: true;
+        readonly can_change_info: true;
+        readonly can_invite_users: true;
+        readonly can_pin_messages: true;
+        readonly can_manage_topics: true;
+    };
+}>;

package/out/convenience/constants.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_CONSTANTS = void 0;
+const bot_js_1 = require("../bot.js");
+const ALL_UPDATE_TYPES = [...bot_js_1.DEFAULT_UPDATE_TYPES, "chat_member"];
+const ALL_CHAT_PERMISSIONS = {
+    can_send_messages: true,
+    can_send_audios: true,
+    can_send_documents: true,
+    can_send_photos: true,
+    can_send_videos: true,
+    can_send_video_notes: true,
+    can_send_voice_notes: true,
+    can_send_polls: true,
+    can_send_other_messages: true,
+    can_add_web_page_previews: true,
+    can_change_info: true,
+    can_invite_users: true,
+    can_pin_messages: true,
+    can_manage_topics: true,
+};
+/**
+ * Contains lists of constants which are useful when working with the Bot API.
+ */
+exports.API_CONSTANTS = Object.freeze({
+    /**
+     * List of all available update types. Useful if you want to receive all
+     * updates from the Bot API, rather than just those that are delivered by
+     * default.
+     *
+     * The main use case for this is when you want to receive `chat_member`
+     * updates, as they need to be enabled first. Use it like so:
+     *
+     * ```ts
+     * // Built-in polling:
+     * bot.start({ allowed_updates: ALL_UPDATE_TYPES });
+     * // grammY runner:
+     * run(bot, { runner: { fetch: { allowed_updates: ALL_UPDATE_TYPES } } });
+     * // Webhooks:
+     * await bot.api.setWebhook(url, { allowed_updates: ALL_UPDATE_TYPES });
+     * ```
+     */
+    ALL_UPDATE_TYPES,
+    /**
+     * An object containing all available chat permissions. Useful if you want
+     * to lift restrictions from a user, as this action requires you to pass
+     * `true` for all permissions. Use it like so:
+     *
+     * ```ts
+     * // On `Bot`:
+     * await bot.api.restrictChatMember(chat_id, user_id, ALL_CHAT_PERMISSIONS);
+     * // On `Api`:
+     * await ctx.api.restrictChatMember(chat_id, user_id, ALL_CHAT_PERMISSIONS);
+     * // On `Context`:
+     * await ctx.restrictChatMember(user_id, ALL_CHAT_PERMISSIONS);
+     * await ctx.restrictAuthor(ALL_CHAT_PERMISSIONS);
+     * ```
+     */
+    ALL_CHAT_PERMISSIONS,
+});