Very Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335import { type Update } from "../types.ts";
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: string) => new Response(json, { status: 200, headers: { "Content-Type": "application/json" }, });const unauthorized = () => new Response('"unauthorized"', { status: 401, statusText: WRONG_TOKEN_ERROR, });
/** * 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 */ // deno-lint-ignore no-explicit-any 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. */// deno-lint-ignore no-explicit-anyexport type FrameworkAdapter = (...args: any[]) => ReqResHandler;
/** express web framework */const express: FrameworkAdapter = (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: FrameworkAdapter = (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: FrameworkAdapter = (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: FrameworkAdapter = (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: FrameworkAdapter = (req: Request) => { let resolveResponse: (res: Response) => void; 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: FrameworkAdapter = (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: FrameworkAdapter = (req, res) => { const secretHeaderFromRequest = req.headers[SECRET_HEADER.toLowerCase()]; return { update: new Promise((resolve, reject) => { // deno-lint-ignore no-explicit-any type Chunk = any; const chunks: Chunk[] = []; req.on("data", (chunk: 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: FrameworkAdapter = (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: FrameworkAdapter = (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: FrameworkAdapter = (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: FrameworkAdapter = ({ request }: { request: Request }) => { let resolveResponse: (res: Response) => void; 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: FrameworkAdapter = (event: { request: Request; respondWith: (res: Promise<Response>) => void;}) => { let resolveResponse: (res: Response) => void; event.respondWith( new Promise<Response>((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: FrameworkAdapter = (request: Request) => { let resolveResponse: (res: Response) => void; 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<Response>((resolve) => { resolveResponse = resolve; }), };};
/** hono web framework */const hono: FrameworkAdapter = (ctx) => { let resolveResponse: (res: Response) => void; 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<Response>((resolve) => { resolveResponse = resolve; }), };};
/** worktop CloudFlare workers framework */const worktop: FrameworkAdapter = (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 adapterexport const 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,};