grammy 1.5.0 → 1.5.4

package/README.md

@@ -12,7 +12,7 @@ _<h2 align="center"> [:mag: Documentation](https://grammy.dev) | [:page_with_cur
 
 [![Bot API](https://img.shields.io/badge/Bot%20API-5.5-blue?logo=telegram&style=flat-square)](https://core.telegram.org/bots/api)
 [![npm](https://img.shields.io/npm/v/grammy?logo=npm&style=flat-square)](https://www.npmjs.org/package/grammy) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-44-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-46-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 <!-- deno-fmt-ignore-end -->
@@ -108,6 +108,16 @@ However, given that most bot developers are still using Node.js, all documentati
 
 You may also be interested in [why we support Deno](https://grammy.dev/resources/faq.html#why-do-you-support-deno).
 
+## Browser Support
+
+The grammY core package in this repository is avaiable as a JavaScript bundle from the CDN at `get.grammy.dev`.
+Currently, we transpile all stable versions (all releases since v1.0) as well as the current `main` branch to ES3, ES5, ES6, and ESNext.
+
+You can download them from the URL `https://get.grammy.dev/[ES version lowercased]@[grammY version including v-prefix].js`.
+For example, the most recent source on `main` in ES6 is available from <https://get.grammy.dev/es6@dev.js>.
+
+So far, this is mainly useful for running bots on Cloudflare Workers.
+
 ## [Contribution Guide »](./CONTRIBUTING.md)
 
 ## Contributors ✨
@@ -175,6 +185,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <tr>
     <td align="center"><a href="http://///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////kraftwerk28.pp.ua"><img src="https://avatars.githubusercontent.com/u/31807671?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vsevolod</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=kraftwerk28" title="Code">💻</a> <a href="#ideas-kraftwerk28" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Akraftwerk28" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/habemuscode"><img src="https://avatars.githubusercontent.com/u/34692207?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Habemuscode</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Ahabemuscode" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://borodutch.com/"><img src="https://avatars.githubusercontent.com/u/3192028?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nikita Kolmogorov</b></sub></a><br /><a href="#plugin-backmeupplz" title="Plugin/utility libraries">🔌</a></td>
+    <td align="center"><a href="http://glukki.ru"><img src="https://avatars.githubusercontent.com/u/140462?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vitaliy Meshchaninov</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aglukki" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=glukki" title="Code">💻</a></td>
   </tr>
 </table>
 

package/out/bot.js

@@ -301,7 +301,7 @@ you can circumvent this protection against memory leaks.`);
             }
             else
                 debugErr(error);
-            debugErr("Call to `getUpdates` failed, retrying in 3 seconds ...");
+            debugErr("Call to getUpdates failed, retrying in 3 seconds ...");
             await new Promise((r) => setTimeout(r, 3000));
         };
         while (this.pollingRunning) {
@@ -313,7 +313,10 @@ you can circumvent this protection against memory leaks.`);
                     updates = await this.api.getUpdates({ offset, limit, timeout, allowed_updates }, this.pollingAbortController.signal);
                 }
                 catch (error) {
-                    await handleErr(error);
+                    if (this.pollingRunning)
+                        await handleErr(error);
+                    else
+                        debug("Pending getUpdates request cancelled");
                 }
             } while (updates === undefined && this.pollingRunning);
             if (updates === undefined)

package/out/composer.js

@@ -299,7 +299,7 @@ class Composer {
         const noAtCommands = new Set();
         toArray(command).forEach((cmd) => {
             if (cmd.startsWith("/")) {
-                throw new Error(`Do not include '/' when registering command handlers (use '${cmd.substr(0, 1)}' not '${cmd}')`);
+                throw new Error(`Do not include '/' when registering command handlers (use '${cmd.substr(1)}' not '${cmd}')`);
             }
             const set = cmd.indexOf("@") === -1 ? noAtCommands : atCommands;
             set.add(cmd);

package/out/context.d.ts

@@ -448,15 +448,14 @@ export declare class Context implements RenamedUpdate {
      */
     setChatAdministratorCustomTitle(user_id: number, custom_title: string, signal?: AbortSignal): Promise<true>;
     /**
-     * Context-aware alias for `api.banChatSenderChat`. Use this method to ban a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
+     * Context-aware alias for `api.banChatSenderChat`. Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
      *
      * @param sender_chat_id Unique identifier of the target sender chat
-     * @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#banchatsenderchat
      */
-    banChatSenderChat(sender_chat_id: number, other?: Other<"banChatSenderChat", "sender_chat_id">, signal?: AbortSignal): Promise<true>;
+    banChatSenderChat(sender_chat_id: number, signal?: AbortSignal): Promise<true>;
     /**
      * Context-aware alias for `api.unbanChatSenderChat`. Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
      *
@@ -772,7 +771,7 @@ export declare class Context implements RenamedUpdate {
      *
      * **Official reference:** https://core.telegram.org/bots/api#sendinvoice
      */
-    replyWithInvoice(title: string, description: string, payload: string, provider_token: string, currency: string, prices: readonly LabeledPrice[], other?: Other<"sendInvoice", "title" | "description" | "payload" | "provider_token" | "start_parameter" | "currency" | "prices">, signal?: AbortSignal): Promise<Message.InvoiceMessage>;
+    replyWithInvoice(title: string, description: string, payload: string, provider_token: string, currency: string, prices: readonly LabeledPrice[], other?: Other<"sendInvoice", "title" | "description" | "payload" | "provider_token" | "currency" | "prices">, signal?: AbortSignal): Promise<Message.InvoiceMessage>;
     /**
      * Context-aware alias for `api.answerShippingQuery`. If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
      *

package/out/context.js

@@ -577,16 +577,15 @@ class Context {
         return this.api.setChatAdministratorCustomTitle(orThrow(this.chat, "setChatAdministratorCustomTitle").id, user_id, custom_title, signal);
     }
     /**
-     * Context-aware alias for `api.banChatSenderChat`. Use this method to ban a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
+     * Context-aware alias for `api.banChatSenderChat`. Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
      *
      * @param sender_chat_id Unique identifier of the target sender chat
-     * @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#banchatsenderchat
      */
-    banChatSenderChat(sender_chat_id, other, signal) {
-        return this.api.banChatSenderChat(orThrow(this.chat, "banChatSenderChat").id, sender_chat_id, other, signal);
+    banChatSenderChat(sender_chat_id, signal) {
+        return this.api.banChatSenderChat(orThrow(this.chat, "banChatSenderChat").id, sender_chat_id, signal);
     }
     /**
      * Context-aware alias for `api.unbanChatSenderChat`. Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

package/out/convenience/keyboard.d.ts

@@ -1,20 +1,20 @@
 import { InlineKeyboardButton, KeyboardButton, LoginUrl } from "../platform.node.js";
 /**
- * Use this class to simplify building a keyboard (something like this:
+ * Use this class to simplify building a custom keyboard (something like this:
  * https://core.telegram.org/bots#keyboards).
  *
  * ```ts
- * // Build a keyboard:
+ * // Build a custom keyboard:
  * const keyboard = new Keyboard()
  *   .text('A').text('B').row()
  *   .text('C').text('D')
  *
  * // Now you can either pass it directly:
- * ctx.reply('Here is your keyboard!', {
+ * ctx.reply('Here is your custom keyboard!', {
  *   reply_markup: keyboard
  * })
  * // Or if you need to specify more options in `reply_markup`:
- * ctx.reply('Here is your keyboard!', {
+ * ctx.reply('Here is your custom keyboard!', {
  *   reply_markup: {
  *     keyboard: keyboard.build(), // note the `build` call
  *     one_time_keyboard: true,
@@ -23,12 +23,12 @@ import { InlineKeyboardButton, KeyboardButton, LoginUrl } from "../platform.node
  * ```
  *
  * Be sure to check out the
- * [documentation](https://grammy.dev/plugins/keyboard.html#keyboards) on
- * keyboards in grammY.
+ * [documentation](https://grammy.dev/plugins/keyboard.html#custom-keyboards) on
+ * custom keyboards in grammY.
  */
 export declare class Keyboard {
     /**
-     * The nested array that holds the keyboard. It will be extended every time
+     * The nested array that holds the custom keyboard. It will be extended every time
      * you call one of the provided methods.
      */
     readonly keyboard: KeyboardButton[][];
@@ -82,8 +82,8 @@ export declare class Keyboard {
      */
     requestPoll(text: string, type?: "quiz" | "regular"): this;
     /**
-     * Return the resulting keyboard that was built. May be called in the end if
-     * necessary so you can specify more options in `reply_markup`.
+     * Return the resulting custom keyboard that was built. May be called in the
+     * end if necessary so you can specify more options in `reply_markup`.
      */
     build(): KeyboardButton[][];
 }

package/out/convenience/keyboard.js

@@ -2,21 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InlineKeyboard = exports.Keyboard = void 0;
 /**
- * Use this class to simplify building a keyboard (something like this:
+ * Use this class to simplify building a custom keyboard (something like this:
  * https://core.telegram.org/bots#keyboards).
  *
  * ```ts
- * // Build a keyboard:
+ * // Build a custom keyboard:
  * const keyboard = new Keyboard()
  *   .text('A').text('B').row()
  *   .text('C').text('D')
  *
  * // Now you can either pass it directly:
- * ctx.reply('Here is your keyboard!', {
+ * ctx.reply('Here is your custom keyboard!', {
  *   reply_markup: keyboard
  * })
  * // Or if you need to specify more options in `reply_markup`:
- * ctx.reply('Here is your keyboard!', {
+ * ctx.reply('Here is your custom keyboard!', {
  *   reply_markup: {
  *     keyboard: keyboard.build(), // note the `build` call
  *     one_time_keyboard: true,
@@ -25,13 +25,13 @@ exports.InlineKeyboard = exports.Keyboard = void 0;
  * ```
  *
  * Be sure to check out the
- * [documentation](https://grammy.dev/plugins/keyboard.html#keyboards) on
- * keyboards in grammY.
+ * [documentation](https://grammy.dev/plugins/keyboard.html#custom-keyboards) on
+ * custom keyboards in grammY.
  */
 class Keyboard {
     constructor() {
         /**
-         * The nested array that holds the keyboard. It will be extended every time
+         * The nested array that holds the custom keyboard. It will be extended every time
          * you call one of the provided methods.
          */
         Object.defineProperty(this, "keyboard", {
@@ -106,8 +106,8 @@ class Keyboard {
         return this.add({ text, request_poll: { type } });
     }
     /**
-     * Return the resulting keyboard that was built. May be called in the end if
-     * necessary so you can specify more options in `reply_markup`.
+     * Return the resulting custom keyboard that was built. May be called in the
+     * end if necessary so you can specify more options in `reply_markup`.
      */
     build() {
         return this.keyboard;

package/out/convenience/session.d.ts

@@ -218,7 +218,13 @@ export declare function lazySession<S, C extends Context>(options?: SessionOptio
  */
 export declare class MemorySessionStorage<S> implements StorageAdapter<S> {
     private readonly timeToLive;
-    private readonly storage;
+    /**
+     * Internally used `Map` instance that stores the session data
+     */
+    protected readonly storage: Map<string, {
+        session: S;
+        expires?: number | undefined;
+    }>;
     /**
      * Constructs a new memory session storage with the given time to live. Note
      * that this storage adapter will not store your data permanently.
@@ -227,6 +233,11 @@ export declare class MemorySessionStorage<S> implements StorageAdapter<S> {
      */
     constructor(timeToLive?: number);
     read(key: string): S | undefined;
+    /**
+     * Reads the values for all keys of the session storage, and returns them as
+     * an array.
+     */
+    readAll(): S[];
     write(key: string, value: S): void;
     private addExpiryDate;
     delete(key: string): void;

package/out/convenience/session.js

@@ -218,6 +218,9 @@ class MemorySessionStorage {
             writable: true,
             value: timeToLive
         });
+        /**
+         * Internally used `Map` instance that stores the session data
+         */
         Object.defineProperty(this, "storage", {
             enumerable: true,
             configurable: true,
@@ -235,6 +238,16 @@ class MemorySessionStorage {
         }
         return value.session;
     }
+    /**
+     * Reads the values for all keys of the session storage, and returns them as
+     * an array.
+     */
+    readAll() {
+        return Array
+            .from(this.storage.keys())
+            .map((key) => this.read(key))
+            .filter((value) => value !== undefined);
+    }
     write(key, value) {
         this.storage.set(key, this.addExpiryDate(value));
     }

package/out/core/api.d.ts

@@ -460,16 +460,15 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     setChatAdministratorCustomTitle(chat_id: number | string, user_id: number, custom_title: string, signal?: AbortSignal): Promise<true>;
     /**
-     * Use this method to ban a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
+     * Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param sender_chat_id Unique identifier of the target sender chat
-     * @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#banchatsenderchat
      */
-    banChatSenderChat(chat_id: number | string, sender_chat_id: number, other?: Other<R, "banChatSenderChat", "sender_chat_id">, signal?: AbortSignal): Promise<true>;
+    banChatSenderChat(chat_id: number | string, sender_chat_id: number, signal?: AbortSignal): Promise<true>;
     /**
      * Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
      *
@@ -959,7 +958,7 @@ export declare class Api<R extends RawApi = RawApi> {
      *
      * **Official reference:** https://core.telegram.org/bots/api#sendinvoice
      */
-    sendInvoice(chat_id: number | string, title: string, description: string, payload: string, provider_token: string, currency: string, prices: readonly LabeledPrice[], other?: Other<R, "sendInvoice", "title" | "description" | "payload" | "provider_token" | "start_parameter" | "currency" | "prices">, signal?: AbortSignal): Promise<import("@grammyjs/types/message").Message.InvoiceMessage>;
+    sendInvoice(chat_id: number | string, title: string, description: string, payload: string, provider_token: string, currency: string, prices: readonly LabeledPrice[], other?: Other<R, "sendInvoice", "title" | "description" | "payload" | "provider_token" | "currency" | "prices">, signal?: AbortSignal): Promise<import("@grammyjs/types/message").Message.InvoiceMessage>;
     /**
      * If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
      *

package/out/core/api.js

@@ -526,17 +526,16 @@ class Api {
         return this.raw.setChatAdministratorCustomTitle({ chat_id, user_id, custom_title }, signal);
     }
     /**
-     * Use this method to ban a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
+     * Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
      *
      * @param chat_id Unique identifier for the target chat or username of the target channel (in the format @channelusername)
      * @param sender_chat_id Unique identifier of the target sender chat
-     * @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#banchatsenderchat
      */
-    banChatSenderChat(chat_id, sender_chat_id, other, signal) {
-        return this.raw.banChatSenderChat({ chat_id, sender_chat_id, ...other }, signal);
+    banChatSenderChat(chat_id, sender_chat_id, signal) {
+        return this.raw.banChatSenderChat({ chat_id, sender_chat_id }, signal);
     }
     /**
      * Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.

package/out/filter.js

@@ -127,9 +127,7 @@ Permitted values are: ${permitted.map((k) => `'${k}'`).join(", ")}.`;
         const permitted = Object.keys(l2Obj);
         return `Invalid L3 filter '${l3}' given in '${filter.join(":")}'. ${permitted.length === 0
             ? `No further filtering is possible after '${l1}:${l2}'.`
-            : `Permitted values are: ${permitted
-                .map((k) => `'${k}'`)
-                .join(", ")}.`}`;
+            : `Permitted values are: ${permitted.map((k) => `'${k}'`).join(", ")}.`}`;
     }
     if (n.length === 0)
         return true;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "grammy",
     "description": "The Telegram Bot Framework.",
-    "version": "1.5.0",
+    "version": "1.5.4",
     "author": "KnorpelSenf",
     "license": "MIT",
     "engines": {
@@ -23,7 +23,7 @@
         "contribs": "all-contributors"
     },
     "dependencies": {
-        "@grammyjs/types": "^2.4.0",
+        "@grammyjs/types": "^2.4.5",
         "abort-controller": "^3.0.0",
         "debug": "^4.3.3",
         "node-fetch": "^2.6.5"