grammy 1.6.2 → 1.7.2

package/out/convenience/session.js

@@ -212,21 +212,11 @@ class MemorySessionStorage {
      * @param timeToLive TTL in milliseconds, default is `Infinity`
      */
     constructor(timeToLive = Infinity) {
-        Object.defineProperty(this, "timeToLive", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: timeToLive
-        });
+        this.timeToLive = timeToLive;
         /**
          * Internally used `Map` instance that stores the session data
          */
-        Object.defineProperty(this, "storage", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: new Map()
-        });
+        this.storage = new Map();
     }
     read(key) {
         const value = this.storage.get(key);

package/out/convenience/webhook.d.ts

@@ -1,18 +1,18 @@
 /// <reference types="node" />
-import { Bot } from "../bot.js";
-import { Update } from "../platform.node.js";
-import { Context } from "../context.js";
+import { type Bot } from "../bot.js";
+import { type Update } from "../platform.node.js";
+import { type Context } from "../context.js";
 declare const adapters: {
     callback: FrameworkAdapter;
     http: (req: import("http").IncomingMessage, res: import("http").ServerResponse) => {
         update: Promise<any>;
-        end: () => void;
-        respond: (json: string) => void;
+        end: () => import("http").ServerResponse;
+        respond: (json: string) => import("http").ServerResponse;
     };
     https: (req: import("http").IncomingMessage, res: import("http").ServerResponse) => {
         update: Promise<any>;
-        end: () => void;
-        respond: (json: string) => void;
+        end: () => import("http").ServerResponse;
+        respond: (json: string) => import("http").ServerResponse;
     };
     express: (req: any, res: any) => {
         update: Promise<any>;
@@ -31,6 +31,10 @@ declare const adapters: {
     };
     worktop: (req: any, res: any) => {
         update: Promise<any>;
+        /**
+         * Middleware for a web framework. Creates a request-response handler for a
+         * request. The handler will be used to integrate with the compatible framework.
+         */
         end: () => any;
         respond: (json: string) => any;
     };

package/out/core/api.d.ts

@@ -1,5 +1,5 @@
-import { BotCommand, ChatPermissions, InlineQueryResult, InputFile, InputMedia, InputMediaAudio, InputMediaDocument, InputMediaPhoto, InputMediaVideo, LabeledPrice, PassportElementError } from "../platform.node.js";
-import { ApiClientOptions, Methods, Payload, RawApi, Transformer, TransformerConsumer, WebhookReplyEnvelope } from "./client.js";
+import { type BotCommand, type ChatPermissions, type InlineQueryResult, type InputFile, type InputMedia, type InputMediaAudio, type InputMediaDocument, type InputMediaPhoto, type InputMediaVideo, type LabeledPrice, type PassportElementError } from "../platform.node.js";
+import { type ApiClientOptions, type Methods, type Payload, type RawApi, type Transformer, type TransformerConsumer, type WebhookReplyEnvelope } from "./client.js";
 declare type AlwaysOmittedInOther = "chat_id";
 /**
  * Helper type to derive remaining properties of a given API method call M,
@@ -589,7 +589,7 @@ export declare class Api<R extends RawApi = RawApi> {
      *
      * **Official reference:** https://core.telegram.org/bots/api#setchatdescription
      */
-    setChatDescription(chat_id: number | string, description: string | undefined, signal?: AbortSignal): Promise<true>;
+    setChatDescription(chat_id: number | string, description?: string, signal?: AbortSignal): Promise<true>;
     /**
      * Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
      *
@@ -845,7 +845,7 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     deleteMessage(chat_id: number | string, message_id: number, signal?: AbortSignal): Promise<true>;
     /**
-     * Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
+     * Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. 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 sticker Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data.
@@ -875,7 +875,7 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     uploadStickerFile(user_id: number, png_sticker: InputFile, signal?: AbortSignal): Promise<import("@grammyjs/types/manage").File>;
     /**
-     * Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.
+     * Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.
      *
      * @param user_id User identifier of created sticker set owner
      * @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.
@@ -888,7 +888,7 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     createNewStickerSet(user_id: number, name: string, title: string, emojis: string, other?: Other<R, "createNewStickerSet", "user_id" | "name" | "title" | "emojis">, signal?: AbortSignal): Promise<true>;
     /**
-     * Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
+     * Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
      *
      * @param user_id User identifier of sticker set owner
      * @param name Sticker set name
@@ -919,16 +919,16 @@ export declare class Api<R extends RawApi = RawApi> {
      */
     deleteStickerFromSet(sticker: string, signal?: AbortSignal): Promise<true>;
     /**
-     * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
+     * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
      *
      * @param name Sticker set name
      * @param user_id User identifier of the sticker set owner
-     * @param thumb A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.. Animated sticker set thumbnail can't be uploaded via HTTP URL.
+     * @param thumb A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.
      * @param signal Optional `AbortSignal` to cancel the request
      *
      * **Official reference:** https://core.telegram.org/bots/api#setstickersetthumb
      */
-    setStickerSetThumb(name: string, user_id: number, thumb: InputFile | string, signal?: AbortSignal): Promise<true>;
+    setStickerSetThumb(name: string, user_id: number, thumb?: InputFile | string, signal?: AbortSignal): Promise<true>;
     /**
      * Use this method to send answers to an inline query. On success, True is returned.
      * No more than 50 results per query are allowed.

package/out/core/api.js

@@ -21,32 +21,6 @@ const client_js_1 = require("./client.js");
  */
 class Api {
     constructor(token, config, webhookReplyEnvelope) {
-        /**
-         * Provides access to all methods of the Telegram Bot API exactly as
-         * documented on the website (https://core.telegram.org/bots/api). No
-         * arguments are pulled up in the function signature for convenience.
-         *
-         * If you suppress compiler warnings, this also allows for raw api calls to
-         * undocumented methods with arbitrary parameters—use only if you know what
-         * you are doing.
-         */
-        Object.defineProperty(this, "raw", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * Configuration object for the API instance, used as a namespace to
-         * separate those API operations that are related to grammY from methods of
-         * the Telegram Bot API. Contains advanced options!
-         */
-        Object.defineProperty(this, "config", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         const { raw, use, installedTransformers } = (0, client_js_1.createRawApi)(token, config, webhookReplyEnvelope);
         this.raw = raw;
         this.config = {
@@ -987,7 +961,7 @@ class Api {
         return this.raw.deleteMessage({ chat_id, message_id }, signal);
     }
     /**
-     * Use this method to send static .WEBP or animated .TGS stickers. On success, the sent Message is returned.
+     * Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. 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 sticker Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a .WEBP file from the Internet, or upload a new one using multipart/form-data.
@@ -1023,7 +997,7 @@ class Api {
         return this.raw.uploadStickerFile({ user_id, png_sticker }, signal);
     }
     /**
-     * Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker or tgs_sticker. Returns True on success.
+     * Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.
      *
      * @param user_id User identifier of created sticker set owner
      * @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.
@@ -1038,7 +1012,7 @@ class Api {
         return this.raw.createNewStickerSet({ user_id, name, title, emojis, ...other }, signal);
     }
     /**
-     * Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker or tgs_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
+     * Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
      *
      * @param user_id User identifier of sticker set owner
      * @param name Sticker set name
@@ -1075,11 +1049,11 @@ class Api {
         return this.raw.deleteStickerFromSet({ sticker }, signal);
     }
     /**
-     * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Returns True on success.
+     * Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
      *
      * @param name Sticker set name
      * @param user_id User identifier of the sticker set owner
-     * @param thumb A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/animated_stickers#technical-requirements for animated sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data.. Animated sticker set thumbnail can't be uploaded via HTTP URL.
+     * @param thumb A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#animated-sticker-requirements for animated sticker technical requirements, or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-sticker-requirements for video sticker technical requirements. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More info on Sending Files ». Animated sticker set thumbnails can't be uploaded via HTTP URL.
      * @param signal Optional `AbortSignal` to cancel the request
      *
      * **Official reference:** https://core.telegram.org/bots/api#setstickersetthumb

package/out/core/client.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node-fetch" />
-import { ApiResponse, Opts, Telegram } from "../platform.node.js";
+import { type ApiResponse, type Opts, type Telegram } from "../platform.node.js";
 export declare type Methods<R extends RawApi> = string & keyof R;
 /**
  * Represents the raw Telegram Bot API with all methods specified 1:1 as
@@ -74,7 +74,26 @@ export interface ApiClientOptions {
      * @param method The API method to be called, e.g. `getMe`
      * @returns The URL that will be fetched during the API call
      */
-    buildUrl?: (root: string, token: string, method: string) => Parameters<typeof fetch>[0];
+    buildUrl?: (root: string, token: string, method: string) => string | URL;
+    /**
+     * Maximum number of seconds that a request to the Bot API server may take.
+     * If a request has not completed before this time has elapsed, grammY
+     * aborts the request and errors. Without such a timeout, networking issues
+     * may cause your bot to leave open a connection indefinitely, which may
+     * effectively make your bot freeze.
+     *
+     * You probably do not have to care about this option. In rare cases, you
+     * may want to adjust it if you are transferring large files via slow
+     * connections to your own Bot API server.
+     *
+     * The default number of seconds is `500`, which corresponds to 8 minutes
+     * and 20 seconds. Note that this is also the value that is hard-coded in
+     * the official Bot API server, so you cannot perform any successful
+     * requests that exceed this time frame (even if you would allow it in
+     * grammY). Setting this option to higher than the default only makes sense
+     * with a custom Bot API server.
+     */
+    timeoutSeconds?: number;
     /**
      * If the bot is running on webhooks, as soon as the bot receives an update
      * from Telegram, it is possible to make up to one API call in the response

package/out/core/client.js

@@ -11,90 +11,64 @@ function concatTransformer(prev, trans) {
 }
 class ApiClient {
     constructor(token, options = {}, webhookReplyEnvelope = {}) {
-        var _a, _b, _c, _d;
-        Object.defineProperty(this, "token", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: token
-        });
-        Object.defineProperty(this, "webhookReplyEnvelope", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: webhookReplyEnvelope
-        });
-        Object.defineProperty(this, "options", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "hasUsedWebhookReply", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "installedTransformers", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        Object.defineProperty(this, "call", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: async (method, payload, signal) => {
-                debug("Calling", method);
-                const url = this.options.buildUrl(this.options.apiRoot, this.token, method);
-                const formDataRequired = (0, payload_js_1.requiresFormDataUpload)(payload);
-                if (this.webhookReplyEnvelope.send !== undefined &&
-                    !this.hasUsedWebhookReply &&
-                    !formDataRequired &&
-                    this.options.canUseWebhookReply(method)) {
-                    this.hasUsedWebhookReply = true;
-                    const config = (0, payload_js_1.createJsonPayload)({ ...payload, method });
-                    await this.webhookReplyEnvelope.send(config.body);
-                    return { ok: true, result: true };
-                }
-                else {
-                    const p = payload !== null && payload !== void 0 ? payload : {};
-                    const sensLogs = this.options.sensitiveLogs;
-                    const abortController = new shim_node_js_1.AbortController();
-                    const abort = combineAborts(abortController, signal);
-                    const res = await new Promise((resolve, reject) => {
-                        function onStreamError(err) {
-                            abort();
-                            reject(err);
-                        }
-                        const onHttpError = toHttpError(method, sensLogs, reject);
-                        const config = formDataRequired
-                            ? (0, payload_js_1.createFormDataPayload)(p, onStreamError)
-                            : (0, payload_js_1.createJsonPayload)(p);
-                        const opts = {
-                            ...this.options.baseFetchConfig,
-                            signal: abortController.signal,
-                            ...config,
-                        };
-                        (0, shim_node_js_1.fetch)(url, opts).then((res) => res.json()).then(resolve)
-                            .catch(onHttpError);
-                    });
-                    return res;
-                }
+        var _a, _b, _c, _d, _e;
+        this.token = token;
+        this.webhookReplyEnvelope = webhookReplyEnvelope;
+        this.hasUsedWebhookReply = false;
+        this.installedTransformers = [];
+        this.call = async (method, p, signal) => {
+            const payload = p !== null && p !== void 0 ? p : {};
+            debug("Calling", method);
+            // General config
+            const opts = this.options;
+            const formDataRequired = (0, payload_js_1.requiresFormDataUpload)(payload);
+            // Short-circuit on webhook reply
+            if (this.webhookReplyEnvelope.send !== undefined &&
+                !this.hasUsedWebhookReply &&
+                !formDataRequired &&
+                opts.canUseWebhookReply(method)) {
+                this.hasUsedWebhookReply = true;
+                const config = (0, payload_js_1.createJsonPayload)({ ...payload, method });
+                await this.webhookReplyEnvelope.send(config.body);
+                return { ok: true, result: true };
             }
-        });
+            // Handle timeouts and errors in the underlying form-data stream
+            const controller = createAbortControllerFromSignal(signal);
+            const timeout = createTimeout(controller, opts.timeoutSeconds, method);
+            const streamErr = createStreamError(controller);
+            // Build request URL and config
+            const url = opts.buildUrl(opts.apiRoot, this.token, method);
+            const config = formDataRequired
+                ? (0, payload_js_1.createFormDataPayload)(payload, (err) => streamErr.catch(err))
+                : (0, payload_js_1.createJsonPayload)(payload);
+            const sig = controller.signal;
+            const options = { ...opts.baseFetchConfig, signal: sig, ...config };
+            // Perform fetch call, and handle networking errors
+            const successPromise = (0, shim_node_js_1.fetch)(url instanceof URL ? url.href : url, options)
+                .catch((0, error_js_1.toHttpError)(method, opts.sensitiveLogs));
+            // Those are the three possible outcomes of the fetch call:
+            const operations = [successPromise, streamErr.promise, timeout.promise];
+            // Wait for result
+            try {
+                const res = await Promise.race(operations);
+                return await res.json();
+            }
+            finally {
+                if (timeout.handle !== undefined)
+                    clearTimeout(timeout.handle);
+            }
+        };
         const apiRoot = (_a = options.apiRoot) !== null && _a !== void 0 ? _a : "https://api.telegram.org";
         this.options = {
             apiRoot,
             buildUrl: (_b = options.buildUrl) !== null && _b !== void 0 ? _b : ((root, token, method) => `${root}/bot${token}/${method}`),
+            timeoutSeconds: (_c = options.timeoutSeconds) !== null && _c !== void 0 ? _c : 500,
             baseFetchConfig: {
                 ...(0, platform_node_js_1.baseFetchConfig)(apiRoot),
                 ...options.baseFetchConfig,
             },
-            canUseWebhookReply: (_c = options.canUseWebhookReply) !== null && _c !== void 0 ? _c : (() => false),
-            sensitiveLogs: (_d = options.sensitiveLogs) !== null && _d !== void 0 ? _d : false,
+            canUseWebhookReply: (_d = options.canUseWebhookReply) !== null && _d !== void 0 ? _d : (() => false),
+            sensitiveLogs: (_e = options.sensitiveLogs) !== null && _e !== void 0 ? _e : false,
         };
         if (this.options.apiRoot.endsWith("/")) {
             throw new Error(`Remove the trailing '/' from the 'apiRoot' option (use '${this.options.apiRoot.substring(0, this.options.apiRoot.length - 1)}' instead of '${this.options.apiRoot}')`);
@@ -109,9 +83,8 @@ class ApiClient {
         const data = await this.call(method, payload, signal);
         if (data.ok)
             return data.result;
-        else {
-            throw new error_js_1.GrammyError(`Call to '${method}' failed!`, data, method, payload);
-        }
+        else
+            throw (0, error_js_1.toGrammyError)(data, method, payload);
     }
 }
 /**
@@ -164,25 +137,36 @@ const proxyMethods = {
         return [];
     },
 };
-function isTelegramError(err) {
-    return (typeof err === "object" &&
-        err !== null &&
-        "status" in err &&
-        "statusText" in err);
+/** Creates a timeout error which aborts a given controller */
+function createTimeout(controller, seconds, method) {
+    let handle = undefined;
+    const promise = new Promise((_, reject) => {
+        handle = setTimeout(() => {
+            const msg = `Request to '${method}' timed out after ${seconds} seconds`;
+            reject(new Error(msg));
+            controller.abort();
+        }, 1000 * seconds);
+    });
+    return { promise, handle };
 }
-function toHttpError(method, sensitiveLogs, reject) {
-    return (err) => {
-        let msg = `Network request for '${method}' failed!`;
-        if (isTelegramError(err))
-            msg += ` (${err.status}: ${err.statusText})`;
-        if (sensitiveLogs && err instanceof Error)
-            msg += ` ${err.message}`;
-        reject(new error_js_1.HttpError(msg, err));
+/** Creates a stream error which abort a given controller */
+function createStreamError(abortController) {
+    let onError = (err) => {
+        // Re-throw by default, but will be overwritten immediately
+        throw err;
     };
+    const promise = new Promise((_, reject) => {
+        onError = (err) => {
+            reject(err);
+            abortController.abort();
+        };
+    });
+    return { promise, catch: onError };
 }
-function combineAborts(abortController, signal) {
+function createAbortControllerFromSignal(signal) {
+    const abortController = new shim_node_js_1.AbortController();
     if (signal === undefined)
-        return () => abortController.abort();
+        return abortController;
     const sig = signal;
     function abort() {
         abortController.abort();
@@ -192,6 +176,6 @@ function combineAborts(abortController, signal) {
         abort();
     else
         sig.addEventListener("abort", abort);
-    return abort;
+    return { abort, signal: abortController.signal };
 }
 const shim_node_js_1 = require("../shim.node.js");

package/out/core/error.d.ts

@@ -1,4 +1,4 @@
-import { ApiError, ResponseParameters } from "../platform.node.js";
+import { type ApiError, type ResponseParameters } from "../platform.node.js";
 /**
  * This class represents errors that are thrown by grammY because the Telegram
  * Bot API responded with an error.
@@ -29,6 +29,7 @@ export declare class GrammyError extends Error implements ApiError {
     /** The payload that was passed when calling the method. */
     payload: Record<string, unknown>);
 }
+export declare function toGrammyError(err: ApiError, method: string, payload: Record<string, unknown>): GrammyError;
 /**
  * This class represents errors that are thrown by grammY because an HTTP call
  * to the Telegram Bot API failed.
@@ -49,3 +50,4 @@ export declare class HttpError extends Error {
     /** The thrown error object. */
     error: unknown);
 }
+export declare function toHttpError(method: string, sensitiveLogs: boolean): (err: unknown) => never;

package/out/core/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpError = exports.GrammyError = void 0;
+exports.toHttpError = exports.HttpError = exports.toGrammyError = exports.GrammyError = void 0;
 /**
  * This class represents errors that are thrown by grammY because the Telegram
  * Bot API responded with an error.
@@ -20,46 +20,10 @@ class GrammyError extends Error {
     payload) {
         var _a;
         super(`${message} (${err.error_code}: ${err.description})`);
-        Object.defineProperty(this, "method", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: method
-        });
-        Object.defineProperty(this, "payload", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: payload
-        });
+        this.method = method;
+        this.payload = payload;
         /** Flag that this request was unsuccessful. Always `false`. */
-        Object.defineProperty(this, "ok", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        /** An integer holding Telegram's error code. Subject to change. */
-        Object.defineProperty(this, "error_code", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** A human-readable description of the error. */
-        Object.defineProperty(this, "description", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /** Further parameters that may help to automatically handle the error. */
-        Object.defineProperty(this, "parameters", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
+        this.ok = false;
         this.name = "GrammyError";
         this.error_code = err.error_code;
         this.description = err.description;
@@ -67,6 +31,10 @@ class GrammyError extends Error {
     }
 }
 exports.GrammyError = GrammyError;
+function toGrammyError(err, method, payload) {
+    return new GrammyError(`Call to '${method}' failed!`, err, method, payload);
+}
+exports.toGrammyError = toGrammyError;
 /**
  * This class represents errors that are thrown by grammY because an HTTP call
  * to the Telegram Bot API failed.
@@ -85,13 +53,25 @@ class HttpError extends Error {
     /** The thrown error object. */
     error) {
         super(message);
-        Object.defineProperty(this, "error", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: error
-        });
+        this.error = error;
         this.name = "HttpError";
     }
 }
 exports.HttpError = HttpError;
+function isTelegramError(err) {
+    return (typeof err === "object" &&
+        err !== null &&
+        "status" in err &&
+        "statusText" in err);
+}
+function toHttpError(method, sensitiveLogs) {
+    return (err) => {
+        let msg = `Network request for '${method}' failed!`;
+        if (isTelegramError(err))
+            msg += ` (${err.status}: ${err.statusText})`;
+        if (sensitiveLogs && err instanceof Error)
+            msg += ` ${err.message}`;
+        throw new HttpError(msg, err);
+    };
+}
+exports.toHttpError = toHttpError;