grammy 1.14.0 → 1.15.0

package/README.md

@@ -10,7 +10,7 @@
 
 <!-- deno-fmt-ignore-start -->
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-6.4-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-6.6-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
 [![Deno](https://shield.deno.dev/x/grammy)](https://deno.land/x/grammy)
 [![npm](https://img.shields.io/npm/v/grammy?logo=npm&style=flat&labelColor=000&color=3b82f6)](https://www.npmjs.org/package/grammy)
 [![All Contributors](https://img.shields.io/github/all-contributors/grammyjs/grammy?style=flat&labelColor=000&color=3b82f6)](#contributors-)
@@ -245,7 +245,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="http://ak4zh.com"><img src="https://avatars.githubusercontent.com/u/26350053?v=4?s=100" width="100px;" alt="ak4zh"/><br /><sub><b>ak4zh</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Aak4zh" title="Reviewed Pull Requests">👀</a> <a href="#ideas-ak4zh" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/commits?author=ak4zh" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/nlapshin"><img src="https://avatars.githubusercontent.com/u/39495311?v=4?s=100" width="100px;" alt="Nikolay Lapshin"/><br /><sub><b>Nikolay Lapshin</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=nlapshin" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Aquathing"><img src="https://avatars.githubusercontent.com/u/81624781?v=4?s=100" width="100px;" alt="Aquatica"/><br /><sub><b>Aquatica</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Aquathing" title="Documentation">📖</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Aquathing"><img src="https://avatars.githubusercontent.com/u/81624781?v=4?s=100" width="100px;" alt="Aquatica"/><br /><sub><b>Aquatica</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Aquathing" title="Documentation">📖</a> <a href="#question-Aquathing" title="Answering Questions">💬</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/fadzikri"><img src="https://avatars.githubusercontent.com/u/109416385?v=4?s=100" width="100px;" alt="Fa Dzikri"/><br /><sub><b>Fa Dzikri</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Afadzikri" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/grammyjs/grammY/commits?author=fadzikri" title="Documentation">📖</a> <a href="#translation-fadzikri" title="Translation">🌍</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/solidprinciples"><img src="https://avatars.githubusercontent.com/u/7939765?v=4?s=100" width="100px;" alt="Chandler Lattin"/><br /><sub><b>Chandler Lattin</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=solidprinciples" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Asolidprinciples" title="Reviewed Pull Requests">👀</a> <a href="#plugin-solidprinciples" title="Plugin/utility libraries">🔌</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/sparfenyuk"><img src="https://avatars.githubusercontent.com/u/134065?v=4?s=100" width="100px;" alt="Sergey Parfenyuk"/><br /><sub><b>Sergey Parfenyuk</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Asparfenyuk" title="Bug reports">🐛</a></td>
@@ -256,7 +256,14 @@ 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/ByMsx"><img src="https://avatars.githubusercontent.com/u/5565836?v=4?s=100" width="100px;" alt="Maxim Lebedev"/><br /><sub><b>Maxim Lebedev</b></sub></a><br /><a href="#ideas-ByMsx" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/commits?author=ByMsx" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Madnex"><img src="https://avatars.githubusercontent.com/u/14137610?v=4?s=100" width="100px;" alt="Madnex"/><br /><sub><b>Madnex</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Madnex" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/tup4ienko"><img src="https://avatars.githubusercontent.com/u/89318613?v=4?s=100" width="100px;" alt="Svyatoslav Tupchienko"/><br /><sub><b>Svyatoslav Tupchienko</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=tup4ienko" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/evermake"><img src="https://avatars.githubusercontent.com/u/53311479?v=4?s=100" width="100px;" alt="Vladislav Deryabkin"/><br /><sub><b>Vladislav Deryabkin</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aevermake" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=evermake" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/evermake"><img src="https://avatars.githubusercontent.com/u/53311479?v=4?s=100" width="100px;" alt="Vladislav Deryabkin"/><br /><sub><b>Vladislav Deryabkin</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aevermake" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=evermake" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Aevermake" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/kashyapndps00"><img src="https://avatars.githubusercontent.com/u/98746601?v=4?s=100" width="100px;" alt="Kashyap Sharma"/><br /><sub><b>Kashyap Sharma</b></sub></a><br /><a href="#example-kashyapndps00" title="Examples">💡</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AlexOwl"><img src="https://avatars.githubusercontent.com/u/47189254?v=4?s=100" width="100px;" alt="AlexOwl"/><br /><sub><b>AlexOwl</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3AAlexOwl" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=AlexOwl" title="Code">💻</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.shrimadhavuk.me/"><img src="https://avatars.githubusercontent.com/u/6317196?v=4?s=100" width="100px;" alt="Shrimadhav U K"/><br /><sub><b>Shrimadhav U K</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=SpEcHiDe" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/binamralamsal"><img src="https://avatars.githubusercontent.com/u/61900781?v=4?s=100" width="100px;" alt="Binamra Lamsal"/><br /><sub><b>Binamra Lamsal</b></sub></a><br /><a href="#ideas-binamralamsal" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/gertminov"><img src="https://avatars.githubusercontent.com/u/78727928?v=4?s=100" width="100px;" alt="gertminov"/><br /><sub><b>gertminov</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=gertminov" title="Documentation">📖</a> <a href="#tutorial-gertminov" title="Tutorials">✅</a></td>
     </tr>
   </tbody>
 </table>

package/out/bot.d.ts

@@ -169,8 +169,10 @@ export declare class Bot<C extends Context = Context, A extends Api = Api> exten
      * Initializes the bot, i.e. fetches information about the bot itself. This
      * method is called automatically, you usually don't have to call it
      * manually.
+     *
+     * @param signal Optional `AbortSignal` to cancel the initialization
      */
-    init(): Promise<void>;
+    init(signal?: AbortSignal): Promise<void>;
     /**
      * Internal. Do not call. Handles an update batch sequentially by supplying
      * it one-by-one to the middleware. Handles middleware errors and stores the
@@ -279,3 +281,4 @@ export declare class Bot<C extends Context = Context, A extends Api = Api> exten
      */
     private handlePollingError;
 }
+import { AbortSignal } from "./shim.node.js";

package/out/bot.js

@@ -113,12 +113,14 @@ class Bot extends composer_js_1.Composer {
      * Initializes the bot, i.e. fetches information about the bot itself. This
      * method is called automatically, you usually don't have to call it
      * manually.
+     *
+     * @param signal Optional `AbortSignal` to cancel the initialization
      */
-    async init() {
+    async init(signal) {
         var _a;
         if (!this.isInited()) {
             debug("Initializing bot");
-            (_a = this.mePromise) !== null && _a !== void 0 ? _a : (this.mePromise = withRetries(() => this.api.getMe()));
+            (_a = this.mePromise) !== null && _a !== void 0 ? _a : (this.mePromise = withRetries(() => this.api.getMe(signal), signal));
             let me;
             try {
                 me = await this.mePromise;
@@ -230,19 +232,26 @@ a known bot info object.");
      * @param options Options to use for simple long polling
      */
     async start(options) {
-        var _a;
+        var _a, _b, _c;
         // Perform setup
-        if (!this.isInited())
-            await this.init();
+        if (!this.isInited()) {
+            await this.init((_a = this.pollingAbortController) === null || _a === void 0 ? void 0 : _a.signal);
+        }
         if (this.pollingRunning) {
             debug("Simple long polling already running!");
             return;
         }
-        await withRetries(() => this.api.deleteWebhook({
-            drop_pending_updates: options === null || options === void 0 ? void 0 : options.drop_pending_updates,
-        }));
+        await withRetries(() => {
+            var _a;
+            return this.api.deleteWebhook({
+                drop_pending_updates: options === null || options === void 0 ? void 0 : options.drop_pending_updates,
+            }, (_a = this.pollingAbortController) === null || _a === void 0 ? void 0 : _a.signal);
+        }, (_b = this.pollingAbortController) === null || _b === void 0 ? void 0 : _b.signal);
         // All async ops of setup complete, run callback
-        await ((_a = options === null || options === void 0 ? void 0 : options.onStart) === null || _a === void 0 ? void 0 : _a.call(options, this.botInfo));
+        await ((_c = options === null || options === void 0 ? void 0 : options.onStart) === null || _c === void 0 ? void 0 : _c.call(options, this.botInfo));
+        // Bot was stopped during `onStart`
+        if (!this.pollingRunning)
+            return;
         // Prevent common misuse that causes memory leak
         this.use = () => {
             throw new Error(`It looks like you are registering more listeners \
@@ -391,13 +400,26 @@ exports.Bot = Bot;
 /**
  * Performs a network call task, retrying upon known errors until success.
  *
+ * If the task errors and a retry_after value can be used, a subsequent retry
+ * will be delayed by the specified period of time.
+ *
+ * Otherwise, if the first attempt at running the task fails, the task is
+ * retried immediately. If second attempt fails, too, waits for 100 ms, and then
+ * doubles this delay for every subsequent attemt. Never waits longer than 1
+ * hour before retrying.
+ *
  * @param task Async task to perform
+ * @param signal Optional `AbortSignal` to prevent further retries
  */
-async function withRetries(task) {
+async function withRetries(task, signal) {
     let result = { ok: false };
+    const INITIAL_DELAY = 100; // ms
+    let delay = INITIAL_DELAY;
     while (!result.ok) {
+        let mustDelay = true;
         try {
             result = { ok: true, value: await task() };
+            mustDelay = false;
         }
         catch (error) {
             debugErr(error);
@@ -408,20 +430,52 @@ async function withRetries(task) {
                     continue;
                 if (error.error_code === 429) {
                     const retryAfter = error.parameters.retry_after;
-                    if (retryAfter !== undefined)
-                        await sleep(retryAfter);
+                    if (retryAfter !== undefined) {
+                        await sleep(retryAfter, signal);
+                        mustDelay = false;
+                    }
                     continue;
                 }
             }
             throw error;
         }
+        finally {
+            if (mustDelay) {
+                if (delay !== INITIAL_DELAY) {
+                    await sleep(delay, signal);
+                }
+                // double the next delay but cap it at 1 hour
+                delay = Math.min(1 * 60 * 60 * 1000, delay + delay);
+            }
+        }
     }
     return result.value;
 }
 /**
- * Returns a new promise that resolves after the specified number of seconds.
+ * Returns a new promise that resolves after the specified number of seconds, or
+ * rejects as soon as the given signal is aborted.
  */
-function sleep(seconds) {
-    return new Promise((r) => setTimeout(r, 1000 * seconds));
+async function sleep(seconds, signal) {
+    let handle;
+    let reject;
+    function abort() {
+        reject === null || reject === void 0 ? void 0 : reject(new Error("Aborted delay"));
+        if (handle !== undefined)
+            clearTimeout(handle);
+    }
+    try {
+        await new Promise((res, rej) => {
+            reject = rej;
+            if (signal === null || signal === void 0 ? void 0 : signal.aborted) {
+                abort();
+                return;
+            }
+            signal === null || signal === void 0 ? void 0 : signal.addEventListener("abort", abort);
+            handle = setTimeout(res, 1000 * seconds);
+        });
+    }
+    finally {
+        signal === null || signal === void 0 ? void 0 : signal.removeEventListener("abort", abort);
+    }
 }
 const shim_node_js_1 = require("./shim.node.js");

package/out/context.d.ts

@@ -426,7 +426,9 @@ export declare class Context implements RenamedUpdate {
      *
      * **Official reference:** https://core.telegram.org/bots/api#editmessagelivelocation
      */
-    editMessageLiveLocation(latitude: number, longitude: number, other?: Other<"editMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & import("@grammyjs/types/message.js").MsgWith<"location">)>;
+    editMessageLiveLocation(latitude: number, longitude: number, other?: Other<"editMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id" | "latitude" | "longitude">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & {
+        location: import("@grammyjs/types/message.js").Location;
+    })>;
     /**
      * Context-aware alias for `api.stopMessageLiveLocation`. Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
      *
@@ -435,7 +437,9 @@ export declare class Context implements RenamedUpdate {
      *
      * **Official reference:** https://core.telegram.org/bots/api#stopmessagelivelocation
      */
-    stopMessageLiveLocation(other?: Other<"stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & import("@grammyjs/types/message.js").MsgWith<"location">)>;
+    stopMessageLiveLocation(other?: Other<"stopMessageLiveLocation", "chat_id" | "message_id" | "inline_message_id">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & {
+        location: import("@grammyjs/types/message.js").Location;
+    })>;
     /**
      * Context-aware alias for `api.sendVenue`. Use this method to send information about a venue. On success, the sent Message is returned.
      *
@@ -939,7 +943,7 @@ export declare class Context implements RenamedUpdate {
      *
      * **Official reference:** https://core.telegram.org/bots/api#setchatmenubutton
      */
-    getChatMenuButton(other?: Other<"getChatMenuButton">, signal?: AbortSignal): Promise<import("@grammyjs/types/menu-button.js").MenuButton>;
+    getChatMenuButton(other?: Other<"getChatMenuButton">, signal?: AbortSignal): Promise<import("@grammyjs/types/settings.js").MenuButton>;
     /**
      * Context-aware alias for `api.setMyDefaultAdministratorRights`. Use this method to the change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
      *
@@ -965,7 +969,9 @@ export declare class Context implements RenamedUpdate {
      *
      * **Official reference:** https://core.telegram.org/bots/api#editmessagetext
      */
-    editMessageText(text: string, other?: Other<"editMessageText", "chat_id" | "message_id" | "inline_message_id" | "text">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & import("@grammyjs/types/message.js").MsgWith<"text">)>;
+    editMessageText(text: string, other?: Other<"editMessageText", "chat_id" | "message_id" | "inline_message_id" | "text">, signal?: AbortSignal): Promise<true | (Update.Edited & Message.CommonMessage & {
+        text: string;
+    })>;
     /**
      * Context-aware alias for `api.editMessageCaption`. Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
      *
@@ -1057,7 +1063,7 @@ export declare class Context implements RenamedUpdate {
      * @param title Product name, 1-32 characters
      * @param description Product description, 1-255 characters
      * @param payload Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
-     * @param provider_token Payments provider token, obtained via BotFather
+     * @param provider_token Payment provider token, obtained via @BotFather
      * @param currency Three-letter ISO 4217 currency code, see more on currencies
      * @param prices Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
      * @param other Optional remaining parameters, confer the official reference below

package/out/context.js

@@ -1298,7 +1298,7 @@ class Context {
      * @param title Product name, 1-32 characters
      * @param description Product description, 1-255 characters
      * @param payload Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
-     * @param provider_token Payments provider token, obtained via BotFather
+     * @param provider_token Payment provider token, obtained via @BotFather
      * @param currency Three-letter ISO 4217 currency code, see more on currencies
      * @param prices Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)
      * @param other Optional remaining parameters, confer the official reference below

package/out/convenience/frameworks.d.ts

@@ -0,0 +1,65 @@
+import { type Update } from "../types.js";
+/**
+ * HTTP Web frameworks for which grammY provides compatible callback out of the
+ * box.
+ */
+export type SupportedFrameworks = keyof typeof adapters;
+/**
+ * Abstraction over a request-response cycle, providing access to the update, as
+ * well as a mechanism for responding to the request and to end it.
+ */
+export interface ReqResHandler {
+    /**
+     * The update object sent from Telegram, usually resolves the request's JSON
+     * body
+     */
+    update: Promise<Update>;
+    /**
+     * X-Telegram-Bot-Api-Secret-Token header of the request, or undefined if
+     * not present
+     */
+    header?: string;
+    /**
+     * Ends the request immediately without body, called after every request
+     * unless a webhook reply was performed
+     */
+    end?: () => void;
+    /**
+     * Sends the specified JSON as a payload in the body, used for webhook
+     * replies
+     */
+    respond: (json: string) => unknown | Promise<unknown>;
+    /**
+     * Responds that the request is unauthorized due to mismatching
+     * X-Telegram-Bot-Api-Secret-Token headers
+     */
+    unauthorized: () => unknown | Promise<unknown>;
+    /**
+     * Some frameworks (e.g. Deno's std/http `listenAndServe`) assume that
+     * handler returns something
+     */
+    handlerReturn?: 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.
+ */
+export type FrameworkAdapter = (...args: any[]) => ReqResHandler;
+export declare const adapters: {
+    express: FrameworkAdapter;
+    koa: FrameworkAdapter;
+    fastify: FrameworkAdapter;
+    serveHttp: FrameworkAdapter;
+    "std/http": FrameworkAdapter;
+    oak: FrameworkAdapter;
+    http: FrameworkAdapter;
+    https: FrameworkAdapter;
+    "aws-lambda": FrameworkAdapter;
+    azure: FrameworkAdapter;
+    "next-js": FrameworkAdapter;
+    sveltekit: FrameworkAdapter;
+    cloudflare: FrameworkAdapter;
+    "cloudflare-mod": FrameworkAdapter;
+    hono: FrameworkAdapter;
+    worktop: FrameworkAdapter;
+};

package/out/convenience/frameworks.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adapters = void 0;
+const SECRET_HEADER = "X-Telegram-Bot-Api-Secret-Token";
+const WRONG_TOKEN_ERROR = "secret token is wrong";
+const ok = () => new Response(null, { status: 200 });
+const okJson = (json) => new Response(json, {
+    status: 200,
+    headers: { "Content-Type": "application/json" },
+});
+const unauthorized = () => new Response('"unauthorized"', {
+    status: 401,
+    statusText: WRONG_TOKEN_ERROR,
+});
+/** express web framework */
+const express = (req, res) => ({
+    update: Promise.resolve(req.body),
+    header: req.header(SECRET_HEADER),
+    end: () => res.end(),
+    respond: (json) => {
+        res.set("Content-Type", "application/json");
+        res.send(json);
+    },
+    unauthorized: () => {
+        res.send(401, WRONG_TOKEN_ERROR);
+    },
+});
+/** koa web framework */
+const koa = (ctx) => ({
+    update: Promise.resolve(ctx.request.body),
+    header: ctx.get(SECRET_HEADER),
+    end: () => {
+        ctx.body = "";
+    },
+    respond: (json) => {
+        ctx.set("Content-Type", "application/json");
+        ctx.response.body = json;
+    },
+    unauthorized: () => {
+        ctx.status = 401;
+    },
+});
+/** fastify web framework */
+const fastify = (req, reply) => ({
+    update: Promise.resolve(req.body),
+    header: req.headers[SECRET_HEADER.toLowerCase()],
+    end: () => reply.status(200).send(),
+    respond: (json) => reply.send(json),
+    unauthorized: () => reply.code(401).send(WRONG_TOKEN_ERROR),
+});
+const serveHttp = (requestEvent) => ({
+    update: requestEvent.request.json(),
+    header: requestEvent.request.headers.get(SECRET_HEADER) || undefined,
+    end: () => requestEvent.respondWith(ok()),
+    respond: (json) => requestEvent.respondWith(okJson(json)),
+    unauthorized: () => requestEvent.respondWith(unauthorized()),
+});
+/** std/http web server */
+const stdHttp = (req) => {
+    let resolveResponse;
+    return {
+        update: req.json(),
+        header: req.headers.get(SECRET_HEADER) || undefined,
+        end: () => {
+            if (resolveResponse)
+                resolveResponse(ok());
+        },
+        respond: (json) => {
+            if (resolveResponse)
+                resolveResponse(okJson(json));
+        },
+        unauthorized: () => {
+            if (resolveResponse)
+                resolveResponse(unauthorized());
+        },
+        handlerReturn: new Promise((resolve) => {
+            resolveResponse = resolve;
+        }),
+    };
+};
+/** oak web framework */
+const oak = (ctx) => ({
+    update: ctx.request.body({ type: "json" }).value,
+    header: ctx.request.headers.get(SECRET_HEADER) || undefined,
+    end: () => {
+        ctx.response.status = 200;
+    },
+    respond: (json) => {
+        ctx.response.type = "json";
+        ctx.response.body = json;
+    },
+    unauthorized: () => {
+        ctx.response.status = 401;
+    },
+});
+/** Node.js native 'http' and 'https' modules */
+const http = (req, res) => {
+    const secretHeaderFromRequest = req.headers[SECRET_HEADER.toLowerCase()];
+    return {
+        update: new Promise((resolve, reject) => {
+            const chunks = [];
+            req.on("data", (chunk) => chunks.push(chunk))
+                .once("end", () => {
+                // @ts-ignore `Buffer` is Node-only
+                const raw = Buffer.concat(chunks).toString("utf-8");
+                resolve(JSON.parse(raw));
+            })
+                .once("error", reject);
+        }),
+        header: Array.isArray(secretHeaderFromRequest)
+            ? secretHeaderFromRequest[0]
+            : secretHeaderFromRequest,
+        end: () => res.end(),
+        respond: (json) => res
+            .writeHead(200, { "Content-Type": "application/json" })
+            .end(json),
+        unauthorized: () => res.writeHead(401).end(WRONG_TOKEN_ERROR),
+    };
+};
+/** AWS lambda serverless functions */
+const awsLambda = (event, _context, callback) => ({
+    update: JSON.parse(event.body),
+    header: event.headers[SECRET_HEADER],
+    end: () => callback(null, { statusCode: 200 }),
+    respond: (json) => callback(null, { statusCode: 200, body: json }),
+    unauthorized: () => callback(null, { statusCode: 401 }),
+});
+/** Azure Functions */
+const azure = (context, req) => ({
+    update: Promise.resolve(req.body),
+    header: context.res.headers[SECRET_HEADER],
+    end: () => (context.res = {
+        status: 200,
+        body: "",
+    }),
+    respond: (json) => {
+        context.res.set("Content-Type", "application/json");
+        context.res.send(json);
+    },
+    unauthorized: () => {
+        context.res.send(401, WRONG_TOKEN_ERROR);
+    },
+});
+/** Next.js Serverless Functions */
+const nextJs = (req, res) => ({
+    update: Promise.resolve(req.body),
+    header: req.headers[SECRET_HEADER],
+    end: () => res.end(),
+    respond: (json) => res.status(200).json(json),
+    unauthorized: () => res.status(401).send(WRONG_TOKEN_ERROR),
+});
+/** Sveltekit Serverless Functions */
+const sveltekit = ({ request }) => {
+    let resolveResponse;
+    return {
+        update: Promise.resolve(request.json()),
+        header: request.headers.get(SECRET_HEADER) || undefined,
+        end: () => {
+            if (resolveResponse)
+                resolveResponse(ok());
+        },
+        respond: (json) => {
+            if (resolveResponse)
+                resolveResponse(okJson(json));
+        },
+        unauthorized: () => {
+            if (resolveResponse)
+                resolveResponse(unauthorized());
+        },
+        handlerReturn: new Promise((resolve) => {
+            resolveResponse = resolve;
+        }),
+    };
+};
+/** Native CloudFlare workers (service worker) */
+const cloudflare = (event) => {
+    let resolveResponse;
+    event.respondWith(new Promise((resolve) => {
+        resolveResponse = resolve;
+    }));
+    return {
+        update: event.request.json(),
+        header: event.request.headers.get(SECRET_HEADER) || undefined,
+        end: () => {
+            resolveResponse(ok());
+        },
+        respond: (json) => {
+            resolveResponse(okJson(json));
+        },
+        unauthorized: () => {
+            resolveResponse(unauthorized());
+        },
+    };
+};
+/** Native CloudFlare workers (module worker) */
+const cloudflareModule = (request) => {
+    let resolveResponse;
+    return {
+        update: request.json(),
+        header: request.headers.get(SECRET_HEADER) || undefined,
+        end: () => {
+            resolveResponse(ok());
+        },
+        respond: (json) => {
+            resolveResponse(okJson(json));
+        },
+        unauthorized: () => {
+            resolveResponse(unauthorized());
+        },
+        handlerReturn: new Promise((resolve) => {
+            resolveResponse = resolve;
+        }),
+    };
+};
+/** hono web framework */
+const hono = (ctx) => {
+    let resolveResponse;
+    return {
+        update: ctx.req.json(),
+        header: ctx.req.headers.get(SECRET_HEADER) || undefined,
+        end: () => {
+            resolveResponse(ctx.body());
+        },
+        respond: (json) => {
+            ctx.header('Content-Type", "application/json');
+            resolveResponse(ctx.body(json));
+        },
+        unauthorized: () => {
+            ctx.status(401);
+            ctx.statusText(WRONG_TOKEN_ERROR);
+            resolveResponse(ctx.body());
+        },
+        handlerReturn: new Promise((resolve) => {
+            resolveResponse = resolve;
+        }),
+    };
+};
+/** worktop CloudFlare workers framework */
+const worktop = (req, res) => ({
+    update: Promise.resolve(req.body.json()),
+    header: req.headers.get(SECRET_HEADER),
+    end: () => res.end(),
+    respond: (json) => res.send(200, json),
+    unauthorized: () => res.send(401, WRONG_TOKEN_ERROR),
+});
+// Please open a PR if you want to add another adapter
+exports.adapters = {
+    express,
+    koa,
+    fastify,
+    serveHttp,
+    "std/http": stdHttp,
+    oak,
+    http,
+    https: http,
+    "aws-lambda": awsLambda,
+    azure,
+    "next-js": nextJs,
+    sveltekit,
+    cloudflare,
+    "cloudflare-mod": cloudflareModule,
+    hono,
+    worktop,
+};

package/out/convenience/session.d.ts

@@ -79,6 +79,22 @@ export interface StorageAdapter<T> {
      * Deletes a value for the given key from the storage.
      */
     delete: (key: string) => MaybePromise<void>;
+    /**
+     * Checks whether a key exists in the storage.
+     */
+    has?: (key: string) => MaybePromise<boolean>;
+    /**
+     * Lists all keys.
+     */
+    readAllKeys?: () => Iterable<string> | AsyncIterable<string>;
+    /**
+     * Lists all values.
+     */
+    readAllValues?: () => Iterable<T> | AsyncIterable<T>;
+    /**
+     * Lists all keys with their values.
+     */
+    readAllEntries?: () => Iterable<[key: string, value: T]> | AsyncIterable<[key: string, value: T]>;
 }
 /**
  * Options for session middleware.
@@ -309,10 +325,13 @@ export declare class MemorySessionStorage<S> implements StorageAdapter<S> {
     constructor(timeToLive?: number | undefined);
     read(key: string): S | undefined;
     /**
-     * Reads the values for all keys of the session storage, and returns them as
-     * an array.
+     * @deprecated Use {@link readAllValues} instead
      */
     readAll(): S[];
+    readAllKeys(): string[];
+    readAllValues(): S[];
+    readAllEntries(): [string, S][];
+    has(key: string): boolean;
     write(key: string, value: S): void;
     delete(key: string): void;
 }

package/out/convenience/session.js

@@ -406,15 +406,28 @@ class MemorySessionStorage {
         return value.session;
     }
     /**
-     * Reads the values for all keys of the session storage, and returns them as
-     * an array.
+     * @deprecated Use {@link readAllValues} instead
      */
     readAll() {
+        return this.readAllValues();
+    }
+    readAllKeys() {
+        return Array.from(this.storage.keys());
+    }
+    readAllValues() {
         return Array
             .from(this.storage.keys())
             .map((key) => this.read(key))
             .filter((value) => value !== undefined);
     }
+    readAllEntries() {
+        return Array.from(this.storage.keys())
+            .map((key) => [key, this.read(key)])
+            .filter((pair) => pair[1] !== undefined);
+    }
+    has(key) {
+        return this.storage.has(key);
+    }
     write(key, value) {
         this.storage.set(key, addExpiryDate(value, this.timeToLive));
     }