gramio 0.0.22 → 0.0.24

package/dist/bot.d.ts

@@ -1,5 +1,6 @@
+import { CallbackData } from "@gramio/callback-data";
 import type { Context, ContextType, MaybeArray, UpdateName } from "@gramio/contexts";
-import type { APIMethodParams, APIMethods, SetMyCommandsParams, TelegramBotCommand, TelegramUser } from "@gramio/types";
+import type { APIMethodParams, APIMethods, SetMyCommandsParams, TelegramBotCommand, TelegramReactionTypeEmojiEmoji, TelegramUser } from "@gramio/types";
 import { Plugin } from "./plugin";
 import type { BotOptions, DeriveDefinitions, ErrorDefinitions, Handler, Hooks, MaybePromise } from "./types";
 import { Updates } from "./updates";
@@ -75,7 +76,11 @@ export declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends D
     preRequest(handler: Hooks.PreRequest): this;
     on<T extends UpdateName>(updateName: MaybeArray<T>, handler: Handler<ContextType<typeof this, T> & Derives["global"] & Derives[T]>): this;
     use(handler: Handler<Context<typeof this> & Derives["global"]>): this;
-    extend<NewPlugin extends Plugin>(plugin: MaybePromise<NewPlugin>): Bot<Errors & NewPlugin["Errors"], Derives & NewPlugin["Derives"]>;
+    extend<NewPlugin extends Plugin<any, any>>(plugin: MaybePromise<NewPlugin>): Bot<Errors & NewPlugin["Errors"], Derives & NewPlugin["Derives"]>;
+    reaction(trigger: MaybeArray<TelegramReactionTypeEmojiEmoji>, handler: (context: ContextType<typeof this, "message_reaction"> & Derives["global"] & Derives["message_reaction"]) => unknown): this;
+    callbackQuery<Trigger extends CallbackData | string | RegExp>(trigger: Trigger, handler: (context: Omit<ContextType<typeof this, "callback_query">, "data"> & Derives["global"] & Derives["callback_query"] & {
+        queryData: Trigger extends CallbackData ? ReturnType<Trigger["unpack"]> : RegExpMatchArray | null;
+    }) => unknown): this;
     hears<Ctx = ContextType<typeof this, "message"> & Derives["global"] & Derives["message"]>(trigger: RegExp | string | ((context: Ctx) => boolean), handler: (context: Ctx & {
         args: RegExpMatchArray | null;
     }) => unknown): this;
@@ -84,9 +89,12 @@ export declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends D
     }) => unknown, options?: Omit<SetMyCommandsParams, "commands"> & Omit<TelegramBotCommand, "command">): this;
     /** Currently not isolated!!! */
     group(grouped: (bot: typeof this) => Bot<any, any>): Bot<any, any>;
+    init(): Promise<void>;
     start({ webhook, dropPendingUpdates, allowedUpdates, }?: {
         webhook?: Omit<APIMethodParams<"setWebhook">, "drop_pending_updates" | "allowed_updates">;
         dropPendingUpdates?: boolean;
         allowedUpdates?: NonNullable<APIMethodParams<"getUpdates">>["allowed_updates"];
-    }): Promise<TelegramUser>;
+    }): Promise<TelegramUser | undefined>;
+    /** Currently does not implement graceful shutdown */
+    stop(): Promise<void>;
 }

package/dist/bot.js

@@ -35,6 +35,7 @@ var __runInitializers = (this && this.__runInitializers) || function (thisArg, i
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Bot = void 0;
+const callback_data_1 = require("@gramio/callback-data");
 const files_1 = require("@gramio/files");
 const format_1 = require("@gramio/format");
 const inspectable_1 = require("inspectable");
@@ -83,6 +84,7 @@ let Bot = (() => {
             preRequest: [],
             onError: [],
             onStart: [],
+            onStop: [],
         };
         constructor(token, options) {
             if (!token || typeof token !== "string")
@@ -281,6 +283,45 @@ let Bot = (() => {
             this.dependencies.push(plugin.name);
             return this;
         }
+        reaction(trigger, handler) {
+            const reactions = Array.isArray(trigger) ? trigger : [trigger];
+            return this.on("message_reaction", (context, next) => {
+                const newReactions = [];
+                for (const reaction of context.newReactions) {
+                    if (reaction.type !== "emoji")
+                        continue;
+                    const foundIndex = context.oldReactions.findIndex((oldReaction) => oldReaction.type === "emoji" &&
+                        oldReaction.emoji === reaction.emoji);
+                    if (foundIndex === -1) {
+                        newReactions.push(reaction);
+                    }
+                    else {
+                        // TODO: REFACTOR
+                        context.oldReactions.splice(foundIndex, 1);
+                    }
+                }
+                if (!newReactions.some((x) => x.type === "emoji" && reactions.includes(x.emoji)))
+                    return next();
+                return handler(context);
+            });
+        }
+        callbackQuery(trigger, handler) {
+            return this.on("callback_query", (context, next) => {
+                if (!context.data)
+                    return next();
+                if (typeof trigger === "string" && context.data !== trigger)
+                    return next();
+                if (trigger instanceof callback_data_1.CallbackData &&
+                    !trigger.regexp().test(context.data))
+                    return next();
+                if (trigger instanceof RegExp && !trigger.test(context.data))
+                    return next();
+                // @ts-expect-error
+                context.queryData = trigger.unpack(context.data);
+                //@ts-expect-error
+                return handler(context);
+            });
+        }
         hears(trigger, handler) {
             return this.on("message", (context, next) => {
                 if ((typeof trigger === "string" && context.text === trigger) ||
@@ -324,9 +365,12 @@ let Bot = (() => {
         group(grouped) {
             return grouped(this);
         }
-        async start({ webhook, dropPendingUpdates, allowedUpdates, } = {}) {
+        async init() {
             await Promise.all(this.lazyloadPlugins.map(async (plugin) => this.extend(await plugin)));
             this.info = await this.api.getMe();
+        }
+        async start({ webhook, dropPendingUpdates, allowedUpdates, } = {}) {
+            await this.init();
             if (!webhook) {
                 await this.api.deleteWebhook({
                     drop_pending_updates: dropPendingUpdates,
@@ -336,6 +380,7 @@ let Bot = (() => {
                 });
                 this.runImmutableHooks("onStart", {
                     plugins: this.dependencies,
+                    // biome-ignore lint/style/noNonNullAssertion: bot.init() guarantees this.info
                     info: this.info,
                     updatesFrom: "long-polling",
                 });
@@ -350,11 +395,24 @@ let Bot = (() => {
             });
             this.runImmutableHooks("onStart", {
                 plugins: this.dependencies,
+                // biome-ignore lint/style/noNonNullAssertion: bot.init() guarantees this.info
                 info: this.info,
                 updatesFrom: "webhook",
             });
             return this.info;
         }
+        /** Currently does not implement graceful shutdown */
+        async stop() {
+            if (this.updates.isStarted)
+                this.updates.stopPolling();
+            else
+                await this.api.deleteWebhook();
+            await this.runImmutableHooks("onStop", {
+                plugins: this.dependencies,
+                // biome-ignore lint/style/noNonNullAssertion: bot.init() guarantees this.info
+                info: this.info,
+            });
+        }
     };
     return Bot = _classThis;
 })();

package/dist/index.d.ts

@@ -8,3 +8,4 @@ export * from "@gramio/files";
 export * from "@gramio/keyboards";
 export * from "@gramio/types";
 export * from "@gramio/format";
+export * from "@gramio/callback-data";

package/dist/index.js

@@ -26,3 +26,4 @@ __exportStar(require("@gramio/files"), exports);
 __exportStar(require("@gramio/keyboards"), exports);
 __exportStar(require("@gramio/types"), exports);
 __exportStar(require("@gramio/format"), exports);
+__exportStar(require("@gramio/callback-data"), exports);

package/dist/types.d.ts

@@ -37,10 +37,15 @@ export declare namespace Hooks {
         info: TelegramUser;
         updatesFrom: "webhook" | "long-polling";
     }) => unknown;
+    type OnStop = (context: {
+        plugins: string[];
+        info: TelegramUser;
+    }) => unknown;
     interface Store<T extends ErrorDefinitions> {
         preRequest: PreRequest[];
         onError: OnError<T>[];
         onStart: OnStart[];
+        onStop: OnStop[];
     }
 }
 export type ErrorDefinitions = Record<string, Error>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gramio",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "Powerful Telegram Bot API framework",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,19 +24,20 @@
   "author": "kravets",
   "license": "ISC",
   "devDependencies": {
-    "@biomejs/biome": "1.6.0",
+    "@biomejs/biome": "1.6.2",
     "@gramio/types": "^7.1.7",
-    "@types/node": "^20.11.25",
-    "typescript": "^5.4.2"
+    "@types/node": "^20.11.30",
+    "typescript": "^5.4.3"
   },
   "dependencies": {
+    "@gramio/callback-data": "^0.0.2",
     "@gramio/contexts": "^0.0.7",
     "@gramio/files": "^0.0.3",
     "@gramio/format": "^0.0.8",
-    "@gramio/keyboards": "^0.2.0",
+    "@gramio/keyboards": "^0.2.2",
     "inspectable": "^3.0.0",
     "middleware-io": "^2.8.1",
-    "undici": "^6.7.1"
+    "undici": "^6.10.1"
   },
   "files": [
     "dist"