gramio 0.4.4 → 0.4.5

package/dist/index.cjs

@@ -7,7 +7,7 @@ var contexts = require('@gramio/contexts');
 var files = require('@gramio/files');
 var format = require('@gramio/format');
 var debug = require('debug');
-var utils = require('./utils-CnG66NLH.cjs');
+var utils = require('./utils-CYIya32k.cjs');
 var middlewareIo = require('middleware-io');
 var keyboards = require('@gramio/keyboards');
 
@@ -1125,8 +1125,9 @@ class Bot {
 
 const SECRET_TOKEN_HEADER = "X-Telegram-Bot-Api-Secret-Token";
 const WRONG_TOKEN_ERROR = "secret token is invalid";
-const responseOK = new Response("ok!");
-const responseUnauthorized = new Response(WRONG_TOKEN_ERROR, {
+const RESPONSE_OK = "ok!";
+const responseOK = () => new Response(RESPONSE_OK);
+const responseUnauthorized = () => new Response(WRONG_TOKEN_ERROR, {
   status: 401
   // @ts-ignore
 });
@@ -1134,22 +1135,26 @@ const frameworks = {
   elysia: ({ body, headers }) => ({
     update: body,
     header: headers[SECRET_TOKEN_HEADER],
-    unauthorized: () => responseUnauthorized
+    unauthorized: responseUnauthorized,
+    response: responseOK
   }),
   fastify: (request, reply) => ({
     update: request.body,
     header: request.headers[SECRET_TOKEN_HEADER],
-    unauthorized: () => reply.code(401).send(WRONG_TOKEN_ERROR)
+    unauthorized: () => reply.code(401).send(WRONG_TOKEN_ERROR),
+    response: () => reply.send(RESPONSE_OK)
   }),
   hono: (c) => ({
     update: c.req.json(),
     header: c.req.header(SECRET_TOKEN_HEADER),
-    unauthorized: () => c.text(WRONG_TOKEN_ERROR, 401)
+    unauthorized: () => c.text(WRONG_TOKEN_ERROR, 401),
+    response: responseOK
   }),
   express: (req, res) => ({
     update: req.body,
     header: req.header(SECRET_TOKEN_HEADER),
-    unauthorized: () => res.status(401).send(WRONG_TOKEN_ERROR)
+    unauthorized: () => res.status(401).send(WRONG_TOKEN_ERROR),
+    response: () => res.send(RESPONSE_OK)
   }),
   koa: (ctx) => ({
     update: ctx.request.body,
@@ -1157,6 +1162,10 @@ const frameworks = {
     unauthorized: () => {
       ctx.status === 401;
       ctx.body = WRONG_TOKEN_ERROR;
+    },
+    response: () => {
+      ctx.status = 200;
+      ctx.body = RESPONSE_OK;
     }
   }),
   http: (req, res) => ({
@@ -1168,38 +1177,59 @@ const frameworks = {
       req.on("end", () => resolve(JSON.parse(body)));
     }),
     header: req.headers[SECRET_TOKEN_HEADER.toLowerCase()],
-    unauthorized: () => res.writeHead(401).end(WRONG_TOKEN_ERROR)
+    unauthorized: () => res.writeHead(401).end(WRONG_TOKEN_ERROR),
+    response: () => res.writeHead(200).end(RESPONSE_OK)
   }),
-  // TODO: Maybe unify it by 'WebRequest'
   "std/http": (req) => ({
     update: req.json(),
     header: req.headers.get(SECRET_TOKEN_HEADER),
-    response: () => responseOK,
-    unauthorized: () => responseUnauthorized
+    response: responseOK,
+    unauthorized: responseUnauthorized
   }),
   "Bun.serve": (req) => ({
     update: req.json(),
     header: req.headers.get(SECRET_TOKEN_HEADER),
-    response: () => responseOK,
-    unauthorized: () => responseUnauthorized
+    response: responseOK,
+    unauthorized: responseUnauthorized
+  }),
+  cloudflare: (req) => ({
+    update: req.json(),
+    header: req.headers.get(SECRET_TOKEN_HEADER),
+    response: responseOK,
+    unauthorized: responseUnauthorized
   }),
   Request: (req) => ({
     update: req.json(),
     header: req.headers.get(SECRET_TOKEN_HEADER),
-    response: () => responseOK,
-    unauthorized: () => responseUnauthorized
+    response: responseOK,
+    unauthorized: responseUnauthorized
   })
 };
 
-function webhookHandler(bot, framework, secretToken) {
+function webhookHandler(bot, framework, secretTokenOrOptions) {
   const frameworkAdapter = frameworks[framework];
+  const secretToken = typeof secretTokenOrOptions === "string" ? secretTokenOrOptions : secretTokenOrOptions?.secretToken;
+  const shouldWaitOptions = typeof secretTokenOrOptions === "string" ? false : secretTokenOrOptions?.shouldWait;
+  const isShouldWait = shouldWaitOptions && (typeof shouldWaitOptions === "object" || typeof shouldWaitOptions === "boolean");
   return async (...args) => {
     const { update, response, header, unauthorized } = frameworkAdapter(
       ...args
     );
     if (secretToken && header !== secretToken) return unauthorized();
-    bot.updates.queue.add(await update);
-    if (response) return response();
+    if (!isShouldWait) {
+      bot.updates.queue.add(await update);
+      if (response) return response();
+    } else {
+      const timeoutOptions = typeof shouldWaitOptions === "object" ? shouldWaitOptions : void 0;
+      const timeout = timeoutOptions?.timeout ?? 3e4;
+      const onTimeout = timeoutOptions?.onTimeout ?? "throw";
+      await utils.timeoutWebhook(
+        bot.updates.handleUpdate(await update, "wait"),
+        timeout,
+        onTimeout
+      );
+      if (response) return response();
+    }
   };
 }
 

package/dist/index.d.cts

@@ -1012,31 +1012,37 @@ declare const frameworks: {
         update: any;
         header: any;
         unauthorized: () => Response;
+        response: () => Response;
     };
     fastify: (request: any, reply: any) => {
         update: any;
         header: any;
         unauthorized: () => any;
+        response: () => any;
     };
     hono: (c: any) => {
         update: any;
         header: any;
         unauthorized: () => any;
+        response: () => Response;
     };
     express: (req: any, res: any) => {
         update: any;
         header: any;
         unauthorized: () => any;
+        response: () => any;
     };
     koa: (ctx: any) => {
         update: any;
         header: any;
         unauthorized: () => void;
+        response: () => void;
     };
     http: (req: any, res: any) => {
         update: Promise<TelegramUpdate>;
         header: any;
         unauthorized: () => any;
+        response: () => any;
     };
     "std/http": (req: any) => {
         update: any;
@@ -1050,6 +1056,12 @@ declare const frameworks: {
         response: () => Response;
         unauthorized: () => Response;
     };
+    cloudflare: (req: any) => {
+        update: any;
+        header: any;
+        response: () => Response;
+        unauthorized: () => Response;
+    };
     Request: (req: any) => {
         update: any;
         header: any;
@@ -1060,6 +1072,16 @@ declare const frameworks: {
 
 /** Union type of webhook handlers name */
 type WebhookHandlers = keyof typeof frameworks;
+interface WebhookHandlerOptionsShouldWait {
+    /** Action to take when timeout occurs. @default "throw" */
+    onTimeout?: "throw" | "return";
+    /** Timeout in milliseconds. @default 10_000 */
+    timeout?: number;
+}
+interface WebhookHandlerOptions {
+    secretToken?: string;
+    shouldWait?: boolean | WebhookHandlerOptionsShouldWait;
+}
 /**
  * Setup handler with yours web-framework to receive updates via webhook
  *
@@ -1088,8 +1110,8 @@ type WebhookHandlers = keyof typeof frameworks;
  * });
  * ```
  */
-declare function webhookHandler<Framework extends keyof typeof frameworks>(bot: Bot, framework: Framework, secretToken?: string): ReturnType<(typeof frameworks)[Framework]> extends {
+declare function webhookHandler<Framework extends keyof typeof frameworks>(bot: Bot, framework: Framework, secretTokenOrOptions?: string | WebhookHandlerOptions): ReturnType<(typeof frameworks)[Framework]> extends {
     response: () => any;
 } ? (...args: Parameters<(typeof frameworks)[Framework]>) => ReturnType<ReturnType<(typeof frameworks)[Framework]>["response"]> : (...args: Parameters<(typeof frameworks)[Framework]>) => void;
 
-export { type AllowedUpdates, type AnyBot, type AnyPlugin, Bot, type BotOptions, type BotStartOptions, type BotStartOptionsLongPolling, type BotStartOptionsWebhook, type CallbackQueryShorthandContext, Composer, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, type MaybeSuppressedReturn, Plugin, type PollingStartOptions, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, Updates, type WebhookHandlers, webhookHandler };
+export { type AllowedUpdates, type AnyBot, type AnyPlugin, Bot, type BotOptions, type BotStartOptions, type BotStartOptionsLongPolling, type BotStartOptionsWebhook, type CallbackQueryShorthandContext, Composer, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, type MaybeSuppressedReturn, Plugin, type PollingStartOptions, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, Updates, type WebhookHandlerOptions, type WebhookHandlerOptionsShouldWait, type WebhookHandlers, webhookHandler };

package/dist/index.d.ts

@@ -1012,31 +1012,37 @@ declare const frameworks: {
         update: any;
         header: any;
         unauthorized: () => Response;
+        response: () => Response;
     };
     fastify: (request: any, reply: any) => {
         update: any;
         header: any;
         unauthorized: () => any;
+        response: () => any;
     };
     hono: (c: any) => {
         update: any;
         header: any;
         unauthorized: () => any;
+        response: () => Response;
     };
     express: (req: any, res: any) => {
         update: any;
         header: any;
         unauthorized: () => any;
+        response: () => any;
     };
     koa: (ctx: any) => {
         update: any;
         header: any;
         unauthorized: () => void;
+        response: () => void;
     };
     http: (req: any, res: any) => {
         update: Promise<TelegramUpdate>;
         header: any;
         unauthorized: () => any;
+        response: () => any;
     };
     "std/http": (req: any) => {
         update: any;
@@ -1050,6 +1056,12 @@ declare const frameworks: {
         response: () => Response;
         unauthorized: () => Response;
     };
+    cloudflare: (req: any) => {
+        update: any;
+        header: any;
+        response: () => Response;
+        unauthorized: () => Response;
+    };
     Request: (req: any) => {
         update: any;
         header: any;
@@ -1060,6 +1072,16 @@ declare const frameworks: {
 
 /** Union type of webhook handlers name */
 type WebhookHandlers = keyof typeof frameworks;
+interface WebhookHandlerOptionsShouldWait {
+    /** Action to take when timeout occurs. @default "throw" */
+    onTimeout?: "throw" | "return";
+    /** Timeout in milliseconds. @default 10_000 */
+    timeout?: number;
+}
+interface WebhookHandlerOptions {
+    secretToken?: string;
+    shouldWait?: boolean | WebhookHandlerOptionsShouldWait;
+}
 /**
  * Setup handler with yours web-framework to receive updates via webhook
  *
@@ -1088,8 +1110,8 @@ type WebhookHandlers = keyof typeof frameworks;
  * });
  * ```
  */
-declare function webhookHandler<Framework extends keyof typeof frameworks>(bot: Bot, framework: Framework, secretToken?: string): ReturnType<(typeof frameworks)[Framework]> extends {
+declare function webhookHandler<Framework extends keyof typeof frameworks>(bot: Bot, framework: Framework, secretTokenOrOptions?: string | WebhookHandlerOptions): ReturnType<(typeof frameworks)[Framework]> extends {
     response: () => any;
 } ? (...args: Parameters<(typeof frameworks)[Framework]>) => ReturnType<ReturnType<(typeof frameworks)[Framework]>["response"]> : (...args: Parameters<(typeof frameworks)[Framework]>) => void;
 
-export { type AllowedUpdates, type AnyBot, type AnyPlugin, Bot, type BotOptions, type BotStartOptions, type BotStartOptionsLongPolling, type BotStartOptionsWebhook, type CallbackQueryShorthandContext, Composer, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, type MaybeSuppressedReturn, Plugin, type PollingStartOptions, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, Updates, type WebhookHandlers, webhookHandler };
+export { type AllowedUpdates, type AnyBot, type AnyPlugin, Bot, type BotOptions, type BotStartOptions, type BotStartOptionsLongPolling, type BotStartOptionsWebhook, type CallbackQueryShorthandContext, Composer, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, type MaybeSuppressedReturn, Plugin, type PollingStartOptions, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, Updates, type WebhookHandlerOptions, type WebhookHandlerOptionsShouldWait, type WebhookHandlers, webhookHandler };

package/dist/index.js

@@ -9,7 +9,7 @@ export * from '@gramio/files';
 import { FormattableMap } from '@gramio/format';
 export * from '@gramio/format';
 import debug from 'debug';
-import { E as ErrorKind, s as sleep, w as withRetries, T as TelegramError, d as debug$updates, I as IS_BUN, a as simplifyObject } from './utils-CJlBu70R.js';
+import { E as ErrorKind, s as sleep, w as withRetries, T as TelegramError, d as debug$updates, I as IS_BUN, a as simplifyObject, t as timeoutWebhook } from './utils-CJfJNxc_.js';
 import { Composer as Composer$1, noopNext } from 'middleware-io';
 export * from '@gramio/keyboards';
 
@@ -1127,8 +1127,9 @@ class Bot {
 
 const SECRET_TOKEN_HEADER = "X-Telegram-Bot-Api-Secret-Token";
 const WRONG_TOKEN_ERROR = "secret token is invalid";
-const responseOK = new Response("ok!");
-const responseUnauthorized = new Response(WRONG_TOKEN_ERROR, {
+const RESPONSE_OK = "ok!";
+const responseOK = () => new Response(RESPONSE_OK);
+const responseUnauthorized = () => new Response(WRONG_TOKEN_ERROR, {
   status: 401
   // @ts-ignore
 });
@@ -1136,22 +1137,26 @@ const frameworks = {
   elysia: ({ body, headers }) => ({
     update: body,
     header: headers[SECRET_TOKEN_HEADER],
-    unauthorized: () => responseUnauthorized
+    unauthorized: responseUnauthorized,
+    response: responseOK
   }),
   fastify: (request, reply) => ({
     update: request.body,
     header: request.headers[SECRET_TOKEN_HEADER],
-    unauthorized: () => reply.code(401).send(WRONG_TOKEN_ERROR)
+    unauthorized: () => reply.code(401).send(WRONG_TOKEN_ERROR),
+    response: () => reply.send(RESPONSE_OK)
   }),
   hono: (c) => ({
     update: c.req.json(),
     header: c.req.header(SECRET_TOKEN_HEADER),
-    unauthorized: () => c.text(WRONG_TOKEN_ERROR, 401)
+    unauthorized: () => c.text(WRONG_TOKEN_ERROR, 401),
+    response: responseOK
   }),
   express: (req, res) => ({
     update: req.body,
     header: req.header(SECRET_TOKEN_HEADER),
-    unauthorized: () => res.status(401).send(WRONG_TOKEN_ERROR)
+    unauthorized: () => res.status(401).send(WRONG_TOKEN_ERROR),
+    response: () => res.send(RESPONSE_OK)
   }),
   koa: (ctx) => ({
     update: ctx.request.body,
@@ -1159,6 +1164,10 @@ const frameworks = {
     unauthorized: () => {
       ctx.status === 401;
       ctx.body = WRONG_TOKEN_ERROR;
+    },
+    response: () => {
+      ctx.status = 200;
+      ctx.body = RESPONSE_OK;
     }
   }),
   http: (req, res) => ({
@@ -1170,38 +1179,59 @@ const frameworks = {
       req.on("end", () => resolve(JSON.parse(body)));
     }),
     header: req.headers[SECRET_TOKEN_HEADER.toLowerCase()],
-    unauthorized: () => res.writeHead(401).end(WRONG_TOKEN_ERROR)
+    unauthorized: () => res.writeHead(401).end(WRONG_TOKEN_ERROR),
+    response: () => res.writeHead(200).end(RESPONSE_OK)
   }),
-  // TODO: Maybe unify it by 'WebRequest'
   "std/http": (req) => ({
     update: req.json(),
     header: req.headers.get(SECRET_TOKEN_HEADER),
-    response: () => responseOK,
-    unauthorized: () => responseUnauthorized
+    response: responseOK,
+    unauthorized: responseUnauthorized
   }),
   "Bun.serve": (req) => ({
     update: req.json(),
     header: req.headers.get(SECRET_TOKEN_HEADER),
-    response: () => responseOK,
-    unauthorized: () => responseUnauthorized
+    response: responseOK,
+    unauthorized: responseUnauthorized
+  }),
+  cloudflare: (req) => ({
+    update: req.json(),
+    header: req.headers.get(SECRET_TOKEN_HEADER),
+    response: responseOK,
+    unauthorized: responseUnauthorized
   }),
   Request: (req) => ({
     update: req.json(),
     header: req.headers.get(SECRET_TOKEN_HEADER),
-    response: () => responseOK,
-    unauthorized: () => responseUnauthorized
+    response: responseOK,
+    unauthorized: responseUnauthorized
   })
 };
 
-function webhookHandler(bot, framework, secretToken) {
+function webhookHandler(bot, framework, secretTokenOrOptions) {
   const frameworkAdapter = frameworks[framework];
+  const secretToken = typeof secretTokenOrOptions === "string" ? secretTokenOrOptions : secretTokenOrOptions?.secretToken;
+  const shouldWaitOptions = typeof secretTokenOrOptions === "string" ? false : secretTokenOrOptions?.shouldWait;
+  const isShouldWait = shouldWaitOptions && (typeof shouldWaitOptions === "object" || typeof shouldWaitOptions === "boolean");
   return async (...args) => {
     const { update, response, header, unauthorized } = frameworkAdapter(
       ...args
     );
     if (secretToken && header !== secretToken) return unauthorized();
-    bot.updates.queue.add(await update);
-    if (response) return response();
+    if (!isShouldWait) {
+      bot.updates.queue.add(await update);
+      if (response) return response();
+    } else {
+      const timeoutOptions = typeof shouldWaitOptions === "object" ? shouldWaitOptions : void 0;
+      const timeout = timeoutOptions?.timeout ?? 3e4;
+      const onTimeout = timeoutOptions?.onTimeout ?? "throw";
+      await timeoutWebhook(
+        bot.updates.handleUpdate(await update, "wait"),
+        timeout,
+        onTimeout
+      );
+      if (response) return response();
+    }
   };
 }
 

package/dist/{utils-CJlBu70R.js → utils-CJfJNxc_.js}

@@ -42,6 +42,20 @@ function simplifyObject(obj) {
 const IS_BUN = typeof Bun !== "undefined";
 debug("gramio:api");
 const debug$updates = debug("gramio:updates");
+function timeoutWebhook(task, timeout, mode) {
+  return new Promise((resolve, reject) => {
+    const timeoutTask = setTimeout(() => {
+      if (mode === "throw") {
+        reject(
+          new Error(`Webhook handler execution timed out after ${timeout}ms`)
+        );
+      } else {
+        resolve(void 0);
+      }
+    }, timeout);
+    task.then(resolve).catch(reject).finally(() => clearTimeout(timeoutTask));
+  });
+}
 
 async function suppressError(fn) {
   try {
@@ -66,4 +80,4 @@ async function withRetries(resultPromise) {
   return result;
 }
 
-export { ErrorKind as E, IS_BUN as I, TelegramError as T, simplifyObject as a, debug$updates as d, sleep as s, withRetries as w };
+export { ErrorKind as E, IS_BUN as I, TelegramError as T, simplifyObject as a, debug$updates as d, sleep as s, timeoutWebhook as t, withRetries as w };

package/dist/{utils-CnG66NLH.cjs → utils-CYIya32k.cjs}

@@ -44,6 +44,20 @@ function simplifyObject(obj) {
 const IS_BUN = typeof Bun !== "undefined";
 debug("gramio:api");
 const debug$updates = debug("gramio:updates");
+function timeoutWebhook(task, timeout, mode) {
+  return new Promise((resolve, reject) => {
+    const timeoutTask = setTimeout(() => {
+      if (mode === "throw") {
+        reject(
+          new Error(`Webhook handler execution timed out after ${timeout}ms`)
+        );
+      } else {
+        resolve(void 0);
+      }
+    }, timeout);
+    task.then(resolve).catch(reject).finally(() => clearTimeout(timeoutTask));
+  });
+}
 
 async function suppressError(fn) {
   try {
@@ -74,4 +88,5 @@ exports.TelegramError = TelegramError;
 exports.debug$updates = debug$updates;
 exports.simplifyObject = simplifyObject;
 exports.sleep = sleep;
+exports.timeoutWebhook = timeoutWebhook;
 exports.withRetries = withRetries;

package/dist/utils.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var utils = require('./utils-CnG66NLH.cjs');
+var utils = require('./utils-CYIya32k.cjs');
 require('debug');
 
 

package/dist/utils.js

@@ -1,2 +1,2 @@
-export { w as withRetries } from './utils-CJlBu70R.js';
+export { w as withRetries } from './utils-CJfJNxc_.js';
 import 'debug';

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "gramio",
 	"type": "module",
-	"version": "0.4.4",
+	"version": "0.4.5",
 	"description": "Powerful, extensible and really type-safe Telegram Bot API framework",
 	"main": "dist/index.cjs",
 	"module": "dist/index.js",
@@ -56,20 +56,20 @@
 	"license": "MIT",
 	"devDependencies": {
 		"@biomejs/biome": "1.9.4",
-		"@types/bun": "^1.2.10",
+		"@types/bun": "^1.2.14",
 		"@types/debug": "^4.1.12",
 		"expect-type": "^1.2.1",
-		"pkgroll": "^2.12.1",
+		"pkgroll": "^2.12.2",
 		"typescript": "^5.8.3"
 	},
 	"dependencies": {
 		"@gramio/callback-data": "^0.0.3",
 		"@gramio/contexts": "^0.2.5",
 		"@gramio/files": "^0.3.0",
-		"@gramio/format": "^0.2.0",
+		"@gramio/format": "^0.2.1",
 		"@gramio/keyboards": "^1.2.1",
 		"@gramio/types": "^9.0.2",
-		"debug": "^4.4.0",
+		"debug": "^4.4.1",
 		"middleware-io": "^2.8.1"
 	},
 	"files": ["dist"]