gramio 0.0.13 → 0.0.14

package/dist/bot.d.ts

@@ -2,9 +2,9 @@ import { Context, ContextType, MaybeArray, UpdateName } from "@gramio/contexts";
 import type { APIMethods } from "@gramio/types";
 import "reflect-metadata";
 import { Plugin } from "#plugin";
-import { BotOptions, ErrorDefinitions, Handler, Hooks } from "./types";
+import { BotOptions, DeriveDefinitions, ErrorDefinitions, Handler, Hooks } from "./types";
 import { Updates } from "./updates";
-export declare class Bot<Errors extends ErrorDefinitions = {}, Derives = {}> {
+export declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends DeriveDefinitions = DeriveDefinitions> {
     readonly options: BotOptions;
     readonly api: APIMethods;
     private errorsDefinitions;
@@ -48,7 +48,7 @@ export declare class Bot<Errors extends ErrorDefinitions = {}, Derives = {}> {
     error<Name extends string, NewError extends {
         new (...args: any): any;
         prototype: Error;
-    }>(kind: Name, error: NewError): Bot<Errors & { [name in Name]: InstanceType<NewError>; }, {}>;
+    }>(kind: Name, error: NewError): Bot<Errors & { [name in Name]: InstanceType<NewError>; }, Derives>;
     /**
      * Set error handler.
      * @example
@@ -58,10 +58,15 @@ export declare class Bot<Errors extends ErrorDefinitions = {}, Derives = {}> {
      * })
      * ```
      */
-    onError<T extends UpdateName>(updateName: MaybeArray<T>, handler: Hooks.OnError<Errors, ContextType<typeof this, T>>): this;
-    onError(handler: Hooks.OnError<Errors>): this;
-    derive<Handler extends (context: Context<typeof this>) => object>(handler: Handler): Bot<Errors, Derives & ReturnType<Handler>>;
-    on<T extends UpdateName>(updateName: MaybeArray<T>, handler: Handler<ContextType<typeof this, T> & Derives>): this;
-    use(handler: Handler<Context<typeof this> & Derives>): this;
+    onError<T extends UpdateName>(updateName: MaybeArray<T>, handler: Hooks.OnError<Errors, ContextType<typeof this, T> & Derives["global"] & Derives[T]>): this;
+    onError(handler: Hooks.OnError<Errors, Context<typeof this> & Derives["global"]>): this;
+    derive<Handler extends Hooks.Derive<Context<typeof this>>>(handler: Handler): Bot<Errors, Derives & {
+        global: ReturnType<Handler>;
+    }>;
+    derive<Update extends UpdateName, Handler extends Hooks.Derive<ContextType<typeof this, Update>>>(updateName: Update, handler: Handler): Bot<Errors, Derives & {
+        [K in Update]: ReturnType<Handler>;
+    }>;
+    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: NewPlugin): Bot<Errors & NewPlugin["Errors"], Derives & NewPlugin["Derives"]>;
 }

package/dist/bot.js

@@ -145,13 +145,21 @@ let Bot = class Bot {
         }
         return this;
     }
-    derive(handler) {
-        this.updates.use((context, next) => {
-            for (const [key, value] of Object.entries(handler(context))) {
-                context[key] = value;
-            }
-            next();
-        });
+    derive(updateNameOrHandler, handler) {
+        if (typeof updateNameOrHandler === "function")
+            this.updates.use((context, next) => {
+                for (const [key, value] of Object.entries(updateNameOrHandler(context))) {
+                    context[key] = value;
+                }
+                next();
+            });
+        else if (handler)
+            this.updates.on(updateNameOrHandler, (context, next) => {
+                for (const [key, value] of Object.entries(handler(context))) {
+                    context[key] = value;
+                }
+                next();
+            });
         return this;
     }
     on(updateName, handler) {
@@ -167,8 +175,12 @@ let Bot = class Bot {
             if (this.errorsDefinitions[key])
                 this.errorsDefinitions[key] = value;
         }
-        for (const derive of plugin.derives) {
-            this.derive(derive);
+        for (const value of plugin.derives) {
+            const [derive, updateName] = value;
+            if (!updateName)
+                this.derive(derive);
+            else
+                this.derive(updateName, derive);
         }
         return this;
     }

package/dist/plugin.d.ts

@@ -1,9 +1,9 @@
-import { BotLike, Context } from "@gramio/contexts";
-import { ErrorDefinitions } from "types";
-export declare class Plugin<Errors extends ErrorDefinitions = {}, Derives = {}> {
+import { BotLike, Context, ContextType, UpdateName } from "@gramio/contexts";
+import { DeriveDefinitions, ErrorDefinitions, Hooks } from "types";
+export declare class Plugin<Errors extends ErrorDefinitions = {}, Derives extends DeriveDefinitions = DeriveDefinitions> {
     Errors: Errors;
     Derives: Derives;
-    derives: ((context: Context<BotLike>) => object)[];
+    derives: [Hooks.Derive<any>, UpdateName | undefined][];
     name: string;
     errorsDefinitions: Record<string, {
         new (...args: any): any;
@@ -16,6 +16,11 @@ export declare class Plugin<Errors extends ErrorDefinitions = {}, Derives = {}>
     error<Name extends string, NewError extends {
         new (...args: any): any;
         prototype: Error;
-    }>(kind: Name, error: NewError): Plugin<Errors & { [name in Name]: InstanceType<NewError>; }, {}>;
-    derive<Handler extends (context: Context<BotLike>) => object>(handler: Handler): Plugin<Errors, Derives & ReturnType<Handler>>;
+    }>(kind: Name, error: NewError): Plugin<Errors & { [name in Name]: InstanceType<NewError>; }, DeriveDefinitions>;
+    derive<Handler extends Hooks.Derive<Context<BotLike>>>(handler: Handler): Plugin<Errors, Derives & {
+        global: ReturnType<Handler>;
+    }>;
+    derive<Update extends UpdateName, Handler extends Hooks.Derive<ContextType<BotLike, Update>>>(updateName: Update, handler: Handler): Plugin<Errors, Derives & {
+        [K in Update]: ReturnType<Handler>;
+    }>;
 }

package/dist/plugin.js

@@ -21,8 +21,11 @@ class Plugin {
         this.errorsDefinitions[kind] = error;
         return this;
     }
-    derive(handler) {
-        this.derives.push(handler);
+    derive(updateNameOrHandler, handler) {
+        if (typeof updateNameOrHandler === "string" && handler)
+            this.derives.push([handler, updateNameOrHandler]);
+        else if (typeof updateNameOrHandler === "function")
+            this.derives.push([updateNameOrHandler, undefined]);
         return this;
     }
 }

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { BotLike, Context } from "@gramio/contexts";
+import { BotLike, Context, UpdateName } from "@gramio/contexts";
 import { APIMethodParams, APIMethods } from "@gramio/types";
 import { NextMiddleware } from "middleware-io";
 import { TelegramError } from "./errors";
@@ -22,6 +22,7 @@ type AnyTelegramMethod = {
 }[keyof APIMethods];
 type MaybePromise<T> = T | Promise<T>;
 export declare namespace Hooks {
+    type Derive<Ctx> = (context: Ctx) => object;
     type PreRequestContext = AnyTelegramMethod;
     type PreRequest = (ctx: PreRequestContext) => MaybePromise<PreRequestContext>;
     type OnErrorContext<Ctx extends Context<BotLike>, T extends ErrorDefinitions> = ErrorHandlerParams<Ctx, "TELEGRAM", AnyTelegramError> | ErrorHandlerParams<Ctx, "UNKNOWN", Error> | {
@@ -34,4 +35,5 @@ export declare namespace Hooks {
     }
 }
 export type ErrorDefinitions = Record<string, Error>;
+export type DeriveDefinitions = Record<UpdateName | "global", {}>;
 export {};

package/package.json

@@ -1,9 +1,20 @@
 {
     "name": "gramio",
-    "version": "0.0.13",
-    "description": "WIP",
+    "version": "0.0.14",
+    "description": "Powerful Telegram Bot API framework",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
+    "keywords": [
+        "telegram",
+        "telegram-bot",
+        "telegram-bot-api",
+        "bot",
+        "framework",
+        "types",
+        "client",
+        "webhook",
+        "long-polling"
+    ],
     "scripts": {
         "type": "tsc --noEmit",
         "lint": "bun check ./src",