gramio 0.0.11 → 0.0.13

package/README.md

@@ -1,7 +1,7 @@
-# GramIO
-
-Work in progress
-
-Currently support Bot API 7.1
-
-See [Documentation](https://gramio.netlify.app/)
+# GramIO
+
+Work in progress
+
+Currently support Bot API 7.1
+
+See [Documentation](https://gramio.netlify.app/)

package/dist/bot.d.ts

@@ -1,8 +1,10 @@
+import { Context, ContextType, MaybeArray, UpdateName } from "@gramio/contexts";
 import type { APIMethods } from "@gramio/types";
 import "reflect-metadata";
-import { BotOptions, ErrorDefinitions, Hooks } from "./types";
+import { Plugin } from "#plugin";
+import { BotOptions, ErrorDefinitions, Handler, Hooks } from "./types";
 import { Updates } from "./updates";
-export declare class Bot<Errors extends ErrorDefinitions = {}> {
+export declare class Bot<Errors extends ErrorDefinitions = {}, Derives = {}> {
     readonly options: BotOptions;
     readonly api: APIMethods;
     private errorsDefinitions;
@@ -46,15 +48,20 @@ export declare class Bot<Errors extends ErrorDefinitions = {}> {
     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>; }, {}>;
     /**
      * Set error handler.
      * @example
      * ```ts
-     * bot.updates.onError(({ context, kind, error }) => {
-     * 	if(context.is("message")) return context.send(`${kind}: ${error.message}`);
+     * bot.onError("message", ({ context, kind, error }) => {
+     * 	return context.send(`${kind}: ${error.message}`);
      * })
      * ```
      */
+    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;
+    extend<NewPlugin extends Plugin>(plugin: NewPlugin): Bot<Errors & NewPlugin["Errors"], Derives & NewPlugin["Derives"]>;
 }

package/dist/bot.js

@@ -38,6 +38,7 @@ let Bot = class Bot {
                 if (!ctx.params)
                     return ctx;
                 const formattable = format_1.FormattableMap[ctx.method];
+                // @ts-ignore add AnyTelegramMethod to @gramio/format
                 if (formattable)
                     ctx.params = formattable(ctx.params);
                 return ctx;
@@ -129,17 +130,46 @@ let Bot = class Bot {
         this.errorsDefinitions[kind] = error;
         return this;
     }
-    /**
-     * Set error handler.
-     * @example
-     * ```ts
-     * bot.updates.onError(({ context, kind, error }) => {
-     * 	if(context.is("message")) return context.send(`${kind}: ${error.message}`);
-     * })
-     * ```
-     */
-    onError(handler) {
-        this.hooks.onError.push(handler);
+    onError(updateNameOrHandler, handler) {
+        if (typeof updateNameOrHandler === "function") {
+            this.hooks.onError.push(updateNameOrHandler);
+            return this;
+        }
+        if (handler) {
+            this.hooks.onError.push(async (errContext) => {
+                if (errContext.context.is(updateNameOrHandler))
+                    // TODO:  Sorry... fix later
+                    //@ts-expect-error
+                    await handler(errContext);
+            });
+        }
+        return this;
+    }
+    derive(handler) {
+        this.updates.use((context, next) => {
+            for (const [key, value] of Object.entries(handler(context))) {
+                context[key] = value;
+            }
+            next();
+        });
+        return this;
+    }
+    on(updateName, handler) {
+        this.updates.on(updateName, handler);
+        return this;
+    }
+    use(handler) {
+        this.updates.use(handler);
+        return this;
+    }
+    extend(plugin) {
+        for (const [key, value] of Object.entries(plugin.errorsDefinitions)) {
+            if (this.errorsDefinitions[key])
+                this.errorsDefinitions[key] = value;
+        }
+        for (const derive of plugin.derives) {
+            this.derive(derive);
+        }
         return this;
     }
 };
@@ -148,5 +178,4 @@ exports.Bot = Bot = __decorate([
     (0, inspectable_1.Inspectable)({
         serialize: () => ({}),
     })
-    // biome-ignore lint/complexity/noBannedTypes: <explanation>
 ], Bot);

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./bot";
 export * from "./errors";
 export * from "./types";
+export * from "./plugin";
 export * from "@gramio/contexts";
 export * from "@gramio/files";
 export * from "@gramio/keyboards";

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./bot"), exports);
 __exportStar(require("./errors"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./plugin"), exports);
 __exportStar(require("@gramio/contexts"), exports);
 __exportStar(require("@gramio/files"), exports);
 __exportStar(require("@gramio/keyboards"), exports);

package/dist/plugin.d.ts

@@ -0,0 +1,21 @@
+import { BotLike, Context } from "@gramio/contexts";
+import { ErrorDefinitions } from "types";
+export declare class Plugin<Errors extends ErrorDefinitions = {}, Derives = {}> {
+    Errors: Errors;
+    Derives: Derives;
+    derives: ((context: Context<BotLike>) => object)[];
+    name: string;
+    errorsDefinitions: Record<string, {
+        new (...args: any): any;
+        prototype: Error;
+    }>;
+    constructor(name: string);
+    /**
+     * Register custom class-error in plugin
+     **/
+    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>>;
+}

package/dist/plugin.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugin = void 0;
+const _errors_1 = require("#errors");
+class Plugin {
+    // TODO: fix that dump error. https://www.typescriptlang.org/play?#code/KYDwDg9gTgLgBDAnmYcCiUrQCLAGYCWAdgTAREQM5wC8cASsAMbQAmAPAFACQlMUxAOYAaHhixROAPgDcnTqEiw4TADYBDStQAKqgK6Di7cdGqgYwIq2omouQiTIVqdAN4BfKXFc8i6gLbAAFxwfAJEgnI8wJim9sSk5FQhjCxQHDy8-EKi3NyucETAAO5wABQAdFXqUIKUIepEiACUDU0ycGBYMBBIKCG2cO48Xm7uUdwsVPx6TD1QZX6BIWFCzd6ZMAAWBJQVS6h0B3LcwzwA9ABUlzxwlwzAhnwxKnp8EP4qGloAtDEScGInX0hiIt2u52isSgXDyADkAqhzJZrKFshFctw4SVBsirNQCkVSpVqrV6nBGi02ogOl1er1kMF0NChrkpGUANbEVghBGBYRwf7QXk46HrHx5c7nAACMEof3AzBgfxZAGVgPBbABpbmZIVQADa2u5AF1aHAuVYTtxNjs9vrKPFHElKAbLawzXR9RNuFANXooEQEHaKdQ9EQOUQIMUg5o4LoDEZMtxbNQAGTeOAGg6AoN84AmkIASWmjSYwAAKoz2NjirYvMM8rIeMMzgpwNB4GpNNQAEK9YzQswgCz45kSJ2JZzmjxeHzybh4ji1hOgwUjlE6EFGSlSdmZMDbogi4qr4i5VpwFdH9ej1FnojsYh4F4P1NeAD8cH7MEHEnT8ZHu+cAhNsuwbHkfowAGQZgdQcaUicrbyO2Shdt81BwhA9AEIIWxyrem7jtAEFFMArD0BAqhMgAROorD+MQNFwAAPnANH+BArAxOo8w0RMUxhLM8xlFg1EhHRDFMax7GcdxUC8dANHipklB6CgCzNNacH7MA5GUdR5picASGcGcgnwBYfDmkSgGJkQZQ0TAykVPqjlwgA8gA+vQRYAOIABIVqqNEClhOF4XKWnyBZcAAEa9DZJTfr0ZTNDwrkblYZRWTAzRAA
+    Errors;
+    Derives;
+    derives = [];
+    name;
+    errorsDefinitions = {};
+    constructor(name) {
+        this.name = name;
+    }
+    /**
+     * Register custom class-error in plugin
+     **/
+    error(kind, error) {
+        //@ts-expect-error Set ErrorKind
+        error[_errors_1.ErrorKind] = kind;
+        this.errorsDefinitions[kind] = error;
+        return this;
+    }
+    derive(handler) {
+        this.derives.push(handler);
+        return this;
+    }
+}
+exports.Plugin = Plugin;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import { Context } from "@gramio/contexts";
+import { BotLike, Context } from "@gramio/contexts";
 import { APIMethodParams, APIMethods } from "@gramio/types";
 import { NextMiddleware } from "middleware-io";
 import { TelegramError } from "./errors";
@@ -6,8 +6,8 @@ export interface BotOptions {
     token?: string;
 }
 export type Handler<T> = (context: T, next: NextMiddleware) => unknown;
-interface ErrorHandlerParams<Kind extends string, Err> {
-    context: Context;
+interface ErrorHandlerParams<Ctx extends Context<BotLike>, Kind extends string, Err> {
+    context: Ctx;
     kind: Kind;
     error: Err;
 }
@@ -24,16 +24,14 @@ type MaybePromise<T> = T | Promise<T>;
 export declare namespace Hooks {
     type PreRequestContext = AnyTelegramMethod;
     type PreRequest = (ctx: PreRequestContext) => MaybePromise<PreRequestContext>;
-    type OnErrorContext<T extends ErrorDefinitions> = ErrorHandlerParams<"TELEGRAM", AnyTelegramError> | ErrorHandlerParams<"UNKNOWN", Error> | {
-        [K in keyof T]: ErrorHandlerParams<K & string, T[K & string]>;
+    type OnErrorContext<Ctx extends Context<BotLike>, T extends ErrorDefinitions> = ErrorHandlerParams<Ctx, "TELEGRAM", AnyTelegramError> | ErrorHandlerParams<Ctx, "UNKNOWN", Error> | {
+        [K in keyof T]: ErrorHandlerParams<Ctx, K & string, T[K & string]>;
     }[keyof T];
-    type OnError<T extends ErrorDefinitions> = (options: OnErrorContext<T>) => unknown;
+    type OnError<T extends ErrorDefinitions, Ctx extends Context<BotLike> = Context<BotLike>> = (options: OnErrorContext<Ctx, T>) => unknown;
     interface Store<T extends ErrorDefinitions> {
         preRequest: PreRequest[];
         onError: OnError<T>[];
     }
 }
-export type ErrorDefinitions = Record<string, {
-    prototype: Error;
-}>;
+export type ErrorDefinitions = Record<string, Error>;
 export {};

package/dist/updates.d.ts

@@ -1,4 +1,4 @@
-import { Context, UpdateName, contextsMappings } from "@gramio/contexts";
+import { Context, MaybeArray, UpdateName } from "@gramio/contexts";
 import type { TelegramUpdate } from "@gramio/types";
 import { CaughtMiddlewareHandler } from "middleware-io";
 import type { Bot } from "./bot";
@@ -9,9 +9,9 @@ export declare class Updates {
     private offset;
     private composer;
     private onError;
-    constructor(bot: Bot<any>, onError: CaughtMiddlewareHandler<Context>);
-    on<T extends UpdateName>(updateName: T, handler: Handler<InstanceType<(typeof contextsMappings)[T]>>): this;
-    use(handler: Handler<Context>): this;
+    constructor(bot: Bot<any, any>, onError: CaughtMiddlewareHandler<Context<any>>);
+    on<T extends UpdateName>(updateName: MaybeArray<T>, handler: Handler<any>): this;
+    use(handler: Handler<any>): this;
     handleUpdate(data: TelegramUpdate): Promise<void>;
     startPolling(): Promise<void>;
     startFetchLoop(): Promise<void>;

package/dist/updates.js

@@ -4,17 +4,16 @@ exports.Updates = void 0;
 const contexts_1 = require("@gramio/contexts");
 const middleware_io_1 = require("middleware-io");
 class Updates {
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
     bot;
     isStarted = false;
     offset = 0;
     composer = middleware_io_1.Composer.builder();
     onError;
-    // biome-ignore lint/suspicious/noExplicitAny: <explanation>
     constructor(bot, onError) {
         this.bot = bot;
         this.onError = onError;
     }
+    //TODO: FIX
     on(updateName, handler) {
         return this.use(async (context, next) => {
             //TODO: fix typings

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "gramio",
-    "version": "0.0.11",
+    "version": "0.0.13",
     "description": "WIP",
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
@@ -14,13 +14,14 @@
     "license": "ISC",
     "devDependencies": {
         "@biomejs/biome": "1.5.3",
-        "@gramio/types": "^7.1.1",
-        "@types/node": "^20.11.19"
+        "@gramio/types": "^7.1.2",
+        "@types/node": "^20.11.19",
+        "typescript": "^5.3.3"
     },
     "dependencies": {
-        "@gramio/contexts": "^0.0.2",
+        "@gramio/contexts": "^0.0.4",
         "@gramio/files": "^0.0.3",
-        "@gramio/format": "^0.0.7",
+        "@gramio/format": "^0.0.8",
         "@gramio/keyboards": "^0.1.6",
         "form-data-encoder": "^4.0.2",
         "inspectable": "^2.1.0",

package/dist/TelegramError.d.ts

@@ -1,8 +0,0 @@
-import { APIMethodParams, APIMethods, TelegramAPIResponseError, TelegramResponseParameters } from "@gramio/types";
-export declare class TelegramError<T extends keyof APIMethods> extends Error {
-    method: T;
-    params: APIMethodParams<T>;
-    code: number;
-    payload?: TelegramResponseParameters;
-    constructor(error: TelegramAPIResponseError, method: T, params: APIMethodParams<T>);
-}

package/dist/TelegramError.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TelegramError = void 0;
-class TelegramError extends Error {
-    method;
-    params;
-    code;
-    payload;
-    constructor(error, method, params) {
-        super(error.description);
-        this.name = method;
-        this.method = method;
-        this.params = params;
-        this.code = error.error_code;
-        if (error.parameters)
-            this.payload = error.parameters;
-    }
-}
-exports.TelegramError = TelegramError;