grammy 1.9.1 → 1.9.2

package/README.md

@@ -1,10 +1,10 @@
-# <h1 align="center"> [![grammY](https://raw.githubusercontent.com/grammyjs/website/main/logos/grammY.png)](https://grammy.dev)</h1>
+<div align="center"><a href="https://grammy.dev"><img src="https://raw.githubusercontent.com/grammyjs/website/main/logos/grammY.png" alt="grammY"></a></h1></div>
 
-**<h1 align="right">The Telegram Bot Framework.</h1>**
+<div align="right">
 
----
+# The Telegram Bot Framework.
 
-_<h2 align="center"> [:mag: Documentation](https://grammy.dev) | [:page_with_curl: API Reference](https://doc.deno.land/https://deno.land/x/grammy/mod.ts) | [:busts_in_silhouette: Group Chat](https://telegram.me/grammyjs) | [:new: News](https://telegram.me/grammyjs_news)</h2>_
+</div>
 
 <div align="center">
 
@@ -17,6 +17,8 @@ _<h2 align="center"> [:mag: Documentation](https://grammy.dev) | [:page_with_cur
 
 <!-- deno-fmt-ignore-end -->
 
+## _[docs.](https://grammy.dev) [reference.](https://doc.deno.land/https://deno.land/x/grammy/mod.ts) [chat.](https://telegram.me/grammyjs) [news.](https://telegram.me/grammyjs_news)_
+
 </div>
 
 **grammY makes it easy to create Telegram bots.** Both for beginners and at scale.
@@ -77,24 +79,29 @@ Here are some more resources to support you:
 ### [grammY Website](https://grammy.dev)
 
 —main project website and documentation.
+Gets you started and explains all concepts.
 
 ### [grammY API Reference](https://doc.deno.land/https://deno.land/x/grammy/mod.ts)
 
 —reference of everything that grammY exports.
+Useful to look up descriptions about any element of grammY.
 
 ### [grammY Example Bots](https://github.com/grammyjs/examples)
 
-—repository full of example bots. Includes a setup to easily run any of them.
+—repository full of example bots.
+Includes a setup to easily run any of them.
 
 ### [grammY Telegram Chat](https://t.me/grammyjs)
 
-—Telegram chat where you can ask any question about grammY or bots in general. We are also open for feedback, ideas, and contributions!
+—Telegram chat where you can ask any question about grammY or bots in general.
+We are also open for feedback, ideas, and contributions!
 
 The Russian commnity chat can be found [here](https://t.me/grammyjs_ru).
 
 ### [grammY News Channel](https://t.me/grammyjs_news)
 
 —Telegram channel where updates to grammY and the ecosystem are posted.
+We are also [on Twitter](https://twitter.com/grammy_js).
 
 ### [Telegram Bot API Reference](https://core.telegram.org/bots/api)
 
@@ -130,7 +137,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <table>
   <tr>
     <td align="center"><a href="https://github.com/KnorpelSenf"><img src="https://avatars.githubusercontent.com/u/12952387?v=4?s=100" width="100px;" alt=""/><br /><sub><b>KnorpelSenf</b></sub></a><br /><a href="#ideas-KnorpelSenf" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/commits?author=KnorpelSenf" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/commits?author=KnorpelSenf" title="Documentation">📖</a> <a href="#design-KnorpelSenf" title="Design">🎨</a> <a href="#example-KnorpelSenf" title="Examples">💡</a> <a href="https://github.com/grammyjs/grammY/commits?author=KnorpelSenf" title="Tests">⚠️</a> <a href="#plugin-KnorpelSenf" title="Plugin/utility libraries">🔌</a> <a href="#platform-KnorpelSenf" title="Packaging/porting to new platform">📦</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3AKnorpelSenf" title="Reviewed Pull Requests">👀</a> <a href="#mentoring-KnorpelSenf" title="Mentoring">🧑‍🏫</a> <a href="#projectManagement-KnorpelSenf" title="Project Management">📆</a> <a href="#infra-KnorpelSenf" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
-    <td align="center"><a href="https://github.com/Tecardo1"><img src="https://avatars.githubusercontent.com/u/42873000?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tecardo1</b></sub></a><br /><a href="#plugin-Tecardo1" title="Plugin/utility libraries">🔌</a> <a href="#userTesting-Tecardo1" title="User Testing">📓</a> <a href="#example-Tecardo1" title="Examples">💡</a> <a href="https://github.com/grammyjs/grammY/commits?author=Tecardo1" title="Documentation">📖</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3ATecardo1" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/HeeroML"><img src="https://avatars.githubusercontent.com/u/42873000?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Heero</b></sub></a><br /><a href="#plugin-HeeroML" title="Plugin/utility libraries">🔌</a> <a href="#userTesting-HeeroML" title="User Testing">📓</a> <a href="#example-HeeroML" title="Examples">💡</a> <a href="https://github.com/grammyjs/grammY/commits?author=HeeroML" title="Documentation">📖</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3AHeeroML" title="Reviewed Pull Requests">👀</a></td>
     <td align="center"><a href="https://github.com/wojpawlik"><img src="https://avatars.githubusercontent.com/u/23058303?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wojciech Pawlik</b></sub></a><br /><a href="#ideas-wojpawlik" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Awojpawlik" title="Reviewed Pull Requests">👀</a> <a href="#infra-wojpawlik" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#platform-wojpawlik" title="Packaging/porting to new platform">📦</a> <a href="#tool-wojpawlik" title="Tools">🔧</a></td>
     <td align="center"><a href="https://github.com/MegaITA"><img src="https://avatars.githubusercontent.com/u/32493080?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alessandro Bertozzi</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=MegaITA" title="Documentation">📖</a></td>
     <td align="center"><a href="https://trgwii.no/"><img src="https://avatars.githubusercontent.com/u/11262022?v=4?s=100" width="100px;" alt=""/><br /><sub><b>trgwii</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=trgwii" title="Code">💻</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3Atrgwii" title="Reviewed Pull Requests">👀</a></td>
@@ -148,7 +155,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   </tr>
   <tr>
     <td align="center"><a href="https://lungers.com/"><img src="https://avatars.githubusercontent.com/u/32808683?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Andrew Lane</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3AAndrewLaneX" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/pulls?q=is%3Apr+reviewed-by%3AAndrewLaneX" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://github.com/code-withAshish"><img src="https://avatars.githubusercontent.com/u/73625149?v=4?s=100" width="100px;" alt=""/><br /><sub><b>code-withAshish</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=code-withAshish" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/code-withAshish"><img src="https://avatars.githubusercontent.com/u/73625149?v=4?s=100" width="100px;" alt=""/><br /><sub><b>code-withAshish</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=code-withAshish" title="Documentation">📖</a> <a href="#question-code-withAshish" title="Answering Questions">💬</a></td>
     <td align="center"><a href="https://beta.ku-di.com/waptik"><img src="https://avatars.githubusercontent.com/u/1687551?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stephane Mensah</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Awaptik" title="Bug reports">🐛</a> <a href="#plugin-waptik" title="Plugin/utility libraries">🔌</a></td>
     <td align="center"><a href="https://github.com/Asaku01"><img src="https://avatars.githubusercontent.com/u/29716396?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Asaku01</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Asaku01" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/ppsimn"><img src="https://avatars.githubusercontent.com/u/88509883?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ppsimn</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Appsimn" title="Bug reports">🐛</a></td>
@@ -209,6 +216,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/Mi3liX9"><img src="https://avatars.githubusercontent.com/u/26169870?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mighty Ali</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/commits?author=Mi3liX9" title="Code">💻</a></td>
     <td align="center"><a href="https://oott123.com"><img src="https://avatars.githubusercontent.com/u/905663?v=4?s=100" width="100px;" alt=""/><br /><sub><b>三三</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aoott123" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=oott123" title="Code">💻</a></td>
   </tr>
+  <tr>
+    <td align="center"><a href="http://roz.ninja"><img src="https://avatars.githubusercontent.com/u/3948961?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Roz</b></sub></a><br /><a href="https://github.com/grammyjs/grammY/issues?q=author%3Aroziscoding" title="Bug reports">🐛</a> <a href="https://github.com/grammyjs/grammY/commits?author=roziscoding" title="Code">💻</a></td>
+  </tr>
 </table>
 
 <!-- markdownlint-restore -->

package/out/convenience/frameworks.node.d.ts

@@ -3,14 +3,14 @@ import { type IncomingMessage, type ServerResponse } from "http";
 export declare const adapters: {
     http: (req: IncomingMessage, res: ServerResponse) => {
         update: Promise<any>;
-        header: string;
+        header: string | undefined;
         end: () => ServerResponse;
         respond: (json: string) => ServerResponse;
         unauthorized: () => ServerResponse;
     };
     https: (req: IncomingMessage, res: ServerResponse) => {
         update: Promise<any>;
-        header: string;
+        header: string | undefined;
         end: () => ServerResponse;
         respond: (json: string) => ServerResponse;
         unauthorized: () => ServerResponse;

package/out/convenience/frameworks.node.js

@@ -3,19 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultAdapter = exports.adapters = void 0;
 const SECRET_HEADER = "X-Telegram-Bot-Api-Secret-Token";
 /** Node.js native 'http' and 'https' modules */
-const http = (req, res) => ({
-    update: new Promise((resolve, reject) => {
-        const chunks = [];
-        req.on("data", (chunk) => chunks.push(chunk)).once("end", () => {
-            const raw = Buffer.concat(chunks).toString("utf-8");
-            resolve(JSON.parse(raw));
-        }).once("error", reject);
-    }),
-    header: String(req.headers[SECRET_HEADER.toLowerCase()]),
-    end: () => res.end(),
-    respond: (json) => res.writeHead(200, { "Content-Type": "application/json" }).end(json),
-    unauthorized: () => res.writeHead(401).end("secret token is wrong"),
-});
+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", () => {
+                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("secret token is wrong"),
+    };
+};
 /** express web framework */
 const express = (req, res) => ({
     update: Promise.resolve(req.body),

package/out/convenience/webhook.d.ts

@@ -6,14 +6,14 @@ declare const adapters: {
     callback: FrameworkAdapter;
     http: (req: import("http").IncomingMessage, res: import("http").ServerResponse) => {
         update: Promise<any>;
-        header: string;
+        header: string | undefined;
         end: () => import("http").ServerResponse;
         respond: (json: string) => import("http").ServerResponse;
         unauthorized: () => import("http").ServerResponse;
     };
     https: (req: import("http").IncomingMessage, res: import("http").ServerResponse) => {
         update: Promise<any>;
-        header: string;
+        header: string | undefined;
         end: () => import("http").ServerResponse;
         respond: (json: string) => import("http").ServerResponse;
         unauthorized: () => import("http").ServerResponse;
@@ -21,7 +21,10 @@ declare const adapters: {
     express: (req: any, res: any) => {
         update: Promise<any>;
         header: any;
-        end: () => any;
+        end: () => any; /**
+         * Ends the request immediately without body, called after every request
+         * unless a webhook reply was performed
+         */
         respond: (json: string) => void;
         unauthorized: () => void;
     };
@@ -44,6 +47,7 @@ declare const adapters: {
         header: any;
         end: () => any;
         respond: (json: string) => any;
+        /** An optional string to compare to X-Telegram-Bot-Api-Secret-Token */
         unauthorized: () => any;
     };
     "aws-lambda": (event: any, _context: any, callback: any) => {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "grammy",
     "description": "The Telegram Bot Framework.",
-    "version": "1.9.1",
+    "version": "1.9.2",
     "author": "KnorpelSenf",
     "license": "MIT",
     "engines": {