gramio 0.1.5 → 0.2.1

package/README.md

@@ -2,8 +2,9 @@
 
 <div align="center">
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-8.0-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-8.1-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
 [![npm](https://img.shields.io/npm/v/gramio?logo=npm&style=flat&labelColor=000&color=3b82f6)](https://www.npmjs.org/package/gramio)
+[![npm downloads](https://img.shields.io/npm/dw/gramio?logo=npm&style=flat&labelColor=000&color=3b82f6)](https://www.npmjs.org/package/gramio)
 [![JSR](https://jsr.io/badges/@gramio/core)](https://jsr.io/@gramio/core)
 [![JSR Score](https://jsr.io/badges/@gramio/core/score)](https://jsr.io/@gramio/core)
 

package/dist/index.cjs

@@ -95,6 +95,9 @@ class Composer {
   compose(context, next = middlewareIo.noopNext) {
     this.composed(context, next);
   }
+  composeWait(context, next = middlewareIo.noopNext) {
+    return this.composed(context, next);
+  }
 }
 
 var __create$1 = Object.create;
@@ -175,6 +178,7 @@ class Plugin {
     errorsDefinitions: {},
     decorators: {}
   };
+  "~" = this._;
   /** Create new Plugin. Please provide `name` */
   constructor(name, { dependencies } = {}) {
     this._.name = name;
@@ -302,24 +306,72 @@ class Plugin {
     }
     return this;
   }
+  /**
+   * ! ** At the moment, it can only pick up types** */
+  extend(plugin) {
+    return this;
+  }
 }
 _init$1 = __decoratorStart$1();
 Plugin = __decorateElement$1(_init$1, 0, "Plugin", _Plugin_decorators, Plugin);
 __runInitializers$1(_init$1, 1, Plugin);
 
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+class UpdateQueue {
+  updateQueue = [];
+  pendingUpdates = /* @__PURE__ */ new Set();
+  handler;
+  onIdleResolver;
+  onIdlePromise;
+  isActive = false;
+  constructor(handler) {
+    this.handler = handler;
+  }
+  add(update) {
+    this.updateQueue.push(update);
+    this.start();
+  }
+  start() {
+    this.isActive = true;
+    while (this.updateQueue.length && this.isActive) {
+      const update = this.updateQueue.shift();
+      if (!update) continue;
+      const promise = this.handler(update);
+      this.pendingUpdates.add(promise);
+      promise.finally(async () => {
+        this.pendingUpdates.delete(promise);
+        if (this.pendingUpdates.size === 0 && this.updateQueue.length === 0 && this.onIdleResolver) {
+          this.onIdleResolver();
+          this.onIdleResolver = void 0;
+        }
+      });
+    }
+  }
+  async stop(timeout = 3e3) {
+    if (this.updateQueue.length === 0 && this.pendingUpdates.size === 0) {
+      return;
+    }
+    this.onIdlePromise = new Promise((resolve) => {
+      this.onIdleResolver = resolve;
+    });
+    await Promise.race([this.onIdlePromise, sleep(timeout)]);
+    this.isActive = false;
+  }
+}
+
 class Updates {
   bot;
   isStarted = false;
   offset = 0;
   composer;
+  queue;
   constructor(bot, onError) {
     this.bot = bot;
     this.composer = new Composer(onError);
+    this.queue = new UpdateQueue(this.handleUpdate.bind(this));
   }
   async handleUpdate(data) {
     const updateType = Object.keys(data).at(1);
-    this.offset = data.update_id + 1;
     const UpdateContext = contexts.contextsMappings[updateType];
     if (!UpdateContext) throw new Error(updateType);
     const updatePayload = data[updateType];
@@ -345,7 +397,7 @@ class Updates {
           updateId: data.update_id
         });
       }
-      this.composer.compose(context);
+      return this.composer.composeWait(context);
     } catch (error) {
       throw new Error(`[UPDATES] Update type ${updateType} not supported.`);
     }
@@ -362,10 +414,13 @@ class Updates {
       try {
         const updates = await this.bot.api.getUpdates({
           ...params,
-          offset: this.offset
+          offset: this.offset,
+          timeout: 30
         });
+        const updateId = updates.at(-1)?.update_id;
+        this.offset = updateId ? updateId + 1 : this.offset;
         for await (const update of updates) {
-          await this.handleUpdate(update).catch(console.error);
+          this.queue.add(update);
         }
       } catch (error) {
         console.error("Error received when fetching updates", error);
@@ -418,12 +473,14 @@ _Bot_decorators = [inspectable.Inspectable({
   serialize: () => ({})
 })];
 class Bot {
+  /** @deprecated use `~` instead*/
   _ = {
-    /** @internal. Remap generic */
+    /** @deprecated @internal. Remap generic */
     derives: {}
   };
-  /** @internal. Remap generic */
+  /** @deprecated use `~.derives` instead @internal. Remap generic */
   __Derives;
+  "~" = this._;
   filters = {
     context: (name2) => (context) => context.is(name2)
   };
@@ -515,7 +572,7 @@ class Bot {
   }
   async _callApi(method, params = {}) {
     const debug$api$method = debug$api.extend(method);
-    const url = `${this.options.api.baseURL}${this.options.token}/${method}`;
+    const url = `${this.options.api.baseURL}${this.options.token}/${this.options.api.useTest ? "test/" : ""}${method}`;
     const reqOptions = {
       method: "POST",
       ...this.options.api.fetchOptions,
@@ -1076,9 +1133,11 @@ class Bot {
    * Stops receiving events via long-polling or webhook
    * Currently does not implement graceful shutdown
    * */
-  async stop() {
-    if (this.updates.isStarted) this.updates.stopPolling();
-    else await this.api.deleteWebhook();
+  async stop(timeout = 3e3) {
+    if (this.updates.isStarted) {
+      this.updates.stopPolling();
+    }
+    await this.updates.queue.stop(timeout);
     await this.runImmutableHooks("onStop", {
       plugins: this.dependencies,
       // biome-ignore lint/style/noNonNullAssertion: bot.init() guarantees this.info

package/dist/index.d.cts

@@ -56,6 +56,7 @@ declare class Composer {
     derive<Update extends UpdateName, Handler extends Hooks.Derive<ContextType<AnyBot, Update>>>(updateNameOrHandler: MaybeArray<Update> | Handler, handler?: Handler): this;
     protected recompose(): this;
     compose(context: Context<AnyBot>, next?: middleware_io.NextMiddleware): void;
+    composeWait(context: Context<AnyBot>, next?: middleware_io.NextMiddleware): unknown;
 }
 
 /**
@@ -132,6 +133,42 @@ declare class Plugin<Errors extends ErrorDefinitions = {}, Derives extends Deriv
         }>;
         decorators: Record<string, unknown>;
     };
+    "~": {
+        /** Name of plugin */
+        name: string;
+        /** List of plugin dependencies. If user does't extend from listed there dependencies it throw a error */
+        dependencies: string[];
+        /** remap generic type. {} in runtime */
+        Errors: Errors;
+        /** remap generic type. {} in runtime */
+        Derives: Derives;
+        /**	Composer */
+        composer: Composer;
+        /** Store plugin preRequests hooks */
+        preRequests: [Hooks.PreRequest<any>, MaybeArray<keyof APIMethods> | undefined][];
+        /** Store plugin onResponses hooks */
+        onResponses: [Hooks.OnResponse<any>, MaybeArray<keyof APIMethods> | undefined][];
+        /** Store plugin onResponseErrors hooks */
+        onResponseErrors: [Hooks.OnResponseError<any>, MaybeArray<keyof APIMethods> | undefined][];
+        /**
+         * Store plugin groups
+         *
+         * If you use `on` or `use` in group and on plugin-level groups handlers are registered after plugin-level handlers
+         *  */
+        groups: ((bot: AnyBot) => AnyBot)[];
+        /** Store plugin onStarts hooks */
+        onStarts: Hooks.OnStart[];
+        /** Store plugin onStops hooks */
+        onStops: Hooks.OnStop[];
+        /** Store plugin onErrors hooks */
+        onErrors: Hooks.OnError<any, any>[];
+        /** Map of plugin errors */
+        errorsDefinitions: Record<string, {
+            new (...args: any): any;
+            prototype: Error;
+        }>;
+        decorators: Record<string, unknown>;
+    };
     /** Create new Plugin. Please provide `name` */
     constructor(name: string, { dependencies }?: {
         dependencies?: string[];
@@ -270,6 +307,9 @@ declare class Plugin<Errors extends ErrorDefinitions = {}, Derives extends Deriv
      */
     onError<T extends UpdateName>(updateName: MaybeArray<T>, handler: Hooks.OnError<Errors, ContextType<Bot, T> & Derives["global"] & Derives[T]>): this;
     onError(handler: Hooks.OnError<Errors, Context<AnyBot> & Derives["global"]>): this;
+    /**
+     * ! ** At the moment, it can only pick up types** */
+    extend<NewPlugin extends AnyPlugin>(plugin: MaybePromise<NewPlugin>): Plugin<Errors & NewPlugin["_"]["Errors"], Derives & NewPlugin["_"]["Derives"]>;
 }
 
 /** Bot options that you can provide to {@link Bot} constructor */
@@ -517,13 +557,27 @@ type AnyBot = Bot<any, any>;
 /** Type of Bot that accepts any generics */
 type AnyPlugin = Plugin<any, any>;
 
+declare class UpdateQueue<Data = TelegramUpdate> {
+    private updateQueue;
+    private pendingUpdates;
+    private handler;
+    private onIdleResolver;
+    private onIdlePromise;
+    private isActive;
+    constructor(handler: (update: Data) => Promise<unknown>);
+    add(update: Data): void;
+    private start;
+    stop(timeout?: number): Promise<void>;
+}
+
 declare class Updates {
     private readonly bot;
     isStarted: boolean;
     private offset;
     composer: Composer;
+    queue: UpdateQueue<TelegramUpdate>;
     constructor(bot: AnyBot, onError: CaughtMiddlewareHandler<Context<any>>);
-    handleUpdate(data: TelegramUpdate): Promise<void>;
+    handleUpdate(data: TelegramUpdate): Promise<unknown>;
     /** @deprecated use bot.start instead @internal */
     startPolling(params?: APIMethodParams<"getUpdates">): Promise<void>;
     startFetchLoop(params?: APIMethodParams<"getUpdates">): Promise<void>;
@@ -544,12 +598,17 @@ declare class Updates {
  * ```
  */
 declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends DeriveDefinitions = DeriveDefinitions> {
+    /** @deprecated use `~` instead*/
     _: {
-        /** @internal. Remap generic */
+        /** @deprecated @internal. Remap generic */
         derives: Derives;
     };
-    /** @internal. Remap generic */
+    /** @deprecated use `~.derives` instead @internal. Remap generic */
     __Derives: Derives;
+    "~": {
+        /** @deprecated @internal. Remap generic */
+        derives: Derives;
+    };
     private filters;
     /** Options provided to instance */
     readonly options: BotOptions;
@@ -927,7 +986,7 @@ declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends DeriveDe
      * Stops receiving events via long-polling or webhook
      * Currently does not implement graceful shutdown
      * */
-    stop(): Promise<void>;
+    stop(timeout?: number): Promise<void>;
 }
 
 declare const frameworks: {

package/dist/index.d.ts

@@ -56,6 +56,7 @@ declare class Composer {
     derive<Update extends UpdateName, Handler extends Hooks.Derive<ContextType<AnyBot, Update>>>(updateNameOrHandler: MaybeArray<Update> | Handler, handler?: Handler): this;
     protected recompose(): this;
     compose(context: Context<AnyBot>, next?: middleware_io.NextMiddleware): void;
+    composeWait(context: Context<AnyBot>, next?: middleware_io.NextMiddleware): unknown;
 }
 
 /**
@@ -132,6 +133,42 @@ declare class Plugin<Errors extends ErrorDefinitions = {}, Derives extends Deriv
         }>;
         decorators: Record<string, unknown>;
     };
+    "~": {
+        /** Name of plugin */
+        name: string;
+        /** List of plugin dependencies. If user does't extend from listed there dependencies it throw a error */
+        dependencies: string[];
+        /** remap generic type. {} in runtime */
+        Errors: Errors;
+        /** remap generic type. {} in runtime */
+        Derives: Derives;
+        /**	Composer */
+        composer: Composer;
+        /** Store plugin preRequests hooks */
+        preRequests: [Hooks.PreRequest<any>, MaybeArray<keyof APIMethods> | undefined][];
+        /** Store plugin onResponses hooks */
+        onResponses: [Hooks.OnResponse<any>, MaybeArray<keyof APIMethods> | undefined][];
+        /** Store plugin onResponseErrors hooks */
+        onResponseErrors: [Hooks.OnResponseError<any>, MaybeArray<keyof APIMethods> | undefined][];
+        /**
+         * Store plugin groups
+         *
+         * If you use `on` or `use` in group and on plugin-level groups handlers are registered after plugin-level handlers
+         *  */
+        groups: ((bot: AnyBot) => AnyBot)[];
+        /** Store plugin onStarts hooks */
+        onStarts: Hooks.OnStart[];
+        /** Store plugin onStops hooks */
+        onStops: Hooks.OnStop[];
+        /** Store plugin onErrors hooks */
+        onErrors: Hooks.OnError<any, any>[];
+        /** Map of plugin errors */
+        errorsDefinitions: Record<string, {
+            new (...args: any): any;
+            prototype: Error;
+        }>;
+        decorators: Record<string, unknown>;
+    };
     /** Create new Plugin. Please provide `name` */
     constructor(name: string, { dependencies }?: {
         dependencies?: string[];
@@ -270,6 +307,9 @@ declare class Plugin<Errors extends ErrorDefinitions = {}, Derives extends Deriv
      */
     onError<T extends UpdateName>(updateName: MaybeArray<T>, handler: Hooks.OnError<Errors, ContextType<Bot, T> & Derives["global"] & Derives[T]>): this;
     onError(handler: Hooks.OnError<Errors, Context<AnyBot> & Derives["global"]>): this;
+    /**
+     * ! ** At the moment, it can only pick up types** */
+    extend<NewPlugin extends AnyPlugin>(plugin: MaybePromise<NewPlugin>): Plugin<Errors & NewPlugin["_"]["Errors"], Derives & NewPlugin["_"]["Derives"]>;
 }
 
 /** Bot options that you can provide to {@link Bot} constructor */
@@ -517,13 +557,27 @@ type AnyBot = Bot<any, any>;
 /** Type of Bot that accepts any generics */
 type AnyPlugin = Plugin<any, any>;
 
+declare class UpdateQueue<Data = TelegramUpdate> {
+    private updateQueue;
+    private pendingUpdates;
+    private handler;
+    private onIdleResolver;
+    private onIdlePromise;
+    private isActive;
+    constructor(handler: (update: Data) => Promise<unknown>);
+    add(update: Data): void;
+    private start;
+    stop(timeout?: number): Promise<void>;
+}
+
 declare class Updates {
     private readonly bot;
     isStarted: boolean;
     private offset;
     composer: Composer;
+    queue: UpdateQueue<TelegramUpdate>;
     constructor(bot: AnyBot, onError: CaughtMiddlewareHandler<Context<any>>);
-    handleUpdate(data: TelegramUpdate): Promise<void>;
+    handleUpdate(data: TelegramUpdate): Promise<unknown>;
     /** @deprecated use bot.start instead @internal */
     startPolling(params?: APIMethodParams<"getUpdates">): Promise<void>;
     startFetchLoop(params?: APIMethodParams<"getUpdates">): Promise<void>;
@@ -544,12 +598,17 @@ declare class Updates {
  * ```
  */
 declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends DeriveDefinitions = DeriveDefinitions> {
+    /** @deprecated use `~` instead*/
     _: {
-        /** @internal. Remap generic */
+        /** @deprecated @internal. Remap generic */
         derives: Derives;
     };
-    /** @internal. Remap generic */
+    /** @deprecated use `~.derives` instead @internal. Remap generic */
     __Derives: Derives;
+    "~": {
+        /** @deprecated @internal. Remap generic */
+        derives: Derives;
+    };
     private filters;
     /** Options provided to instance */
     readonly options: BotOptions;
@@ -927,7 +986,7 @@ declare class Bot<Errors extends ErrorDefinitions = {}, Derives extends DeriveDe
      * Stops receiving events via long-polling or webhook
      * Currently does not implement graceful shutdown
      * */
-    stop(): Promise<void>;
+    stop(timeout?: number): Promise<void>;
 }
 
 declare const frameworks: {

package/dist/index.js

@@ -97,6 +97,9 @@ class Composer {
   compose(context, next = noopNext) {
     this.composed(context, next);
   }
+  composeWait(context, next = noopNext) {
+    return this.composed(context, next);
+  }
 }
 
 var __create$1 = Object.create;
@@ -177,6 +180,7 @@ class Plugin {
     errorsDefinitions: {},
     decorators: {}
   };
+  "~" = this._;
   /** Create new Plugin. Please provide `name` */
   constructor(name, { dependencies } = {}) {
     this._.name = name;
@@ -304,24 +308,72 @@ class Plugin {
     }
     return this;
   }
+  /**
+   * ! ** At the moment, it can only pick up types** */
+  extend(plugin) {
+    return this;
+  }
 }
 _init$1 = __decoratorStart$1();
 Plugin = __decorateElement$1(_init$1, 0, "Plugin", _Plugin_decorators, Plugin);
 __runInitializers$1(_init$1, 1, Plugin);
 
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+class UpdateQueue {
+  updateQueue = [];
+  pendingUpdates = /* @__PURE__ */ new Set();
+  handler;
+  onIdleResolver;
+  onIdlePromise;
+  isActive = false;
+  constructor(handler) {
+    this.handler = handler;
+  }
+  add(update) {
+    this.updateQueue.push(update);
+    this.start();
+  }
+  start() {
+    this.isActive = true;
+    while (this.updateQueue.length && this.isActive) {
+      const update = this.updateQueue.shift();
+      if (!update) continue;
+      const promise = this.handler(update);
+      this.pendingUpdates.add(promise);
+      promise.finally(async () => {
+        this.pendingUpdates.delete(promise);
+        if (this.pendingUpdates.size === 0 && this.updateQueue.length === 0 && this.onIdleResolver) {
+          this.onIdleResolver();
+          this.onIdleResolver = void 0;
+        }
+      });
+    }
+  }
+  async stop(timeout = 3e3) {
+    if (this.updateQueue.length === 0 && this.pendingUpdates.size === 0) {
+      return;
+    }
+    this.onIdlePromise = new Promise((resolve) => {
+      this.onIdleResolver = resolve;
+    });
+    await Promise.race([this.onIdlePromise, sleep(timeout)]);
+    this.isActive = false;
+  }
+}
+
 class Updates {
   bot;
   isStarted = false;
   offset = 0;
   composer;
+  queue;
   constructor(bot, onError) {
     this.bot = bot;
     this.composer = new Composer(onError);
+    this.queue = new UpdateQueue(this.handleUpdate.bind(this));
   }
   async handleUpdate(data) {
     const updateType = Object.keys(data).at(1);
-    this.offset = data.update_id + 1;
     const UpdateContext = contextsMappings[updateType];
     if (!UpdateContext) throw new Error(updateType);
     const updatePayload = data[updateType];
@@ -347,7 +399,7 @@ class Updates {
           updateId: data.update_id
         });
       }
-      this.composer.compose(context);
+      return this.composer.composeWait(context);
     } catch (error) {
       throw new Error(`[UPDATES] Update type ${updateType} not supported.`);
     }
@@ -364,10 +416,13 @@ class Updates {
       try {
         const updates = await this.bot.api.getUpdates({
           ...params,
-          offset: this.offset
+          offset: this.offset,
+          timeout: 30
         });
+        const updateId = updates.at(-1)?.update_id;
+        this.offset = updateId ? updateId + 1 : this.offset;
         for await (const update of updates) {
-          await this.handleUpdate(update).catch(console.error);
+          this.queue.add(update);
         }
       } catch (error) {
         console.error("Error received when fetching updates", error);
@@ -420,12 +475,14 @@ _Bot_decorators = [Inspectable({
   serialize: () => ({})
 })];
 class Bot {
+  /** @deprecated use `~` instead*/
   _ = {
-    /** @internal. Remap generic */
+    /** @deprecated @internal. Remap generic */
     derives: {}
   };
-  /** @internal. Remap generic */
+  /** @deprecated use `~.derives` instead @internal. Remap generic */
   __Derives;
+  "~" = this._;
   filters = {
     context: (name2) => (context) => context.is(name2)
   };
@@ -517,7 +574,7 @@ class Bot {
   }
   async _callApi(method, params = {}) {
     const debug$api$method = debug$api.extend(method);
-    const url = `${this.options.api.baseURL}${this.options.token}/${method}`;
+    const url = `${this.options.api.baseURL}${this.options.token}/${this.options.api.useTest ? "test/" : ""}${method}`;
     const reqOptions = {
       method: "POST",
       ...this.options.api.fetchOptions,
@@ -1078,9 +1135,11 @@ class Bot {
    * Stops receiving events via long-polling or webhook
    * Currently does not implement graceful shutdown
    * */
-  async stop() {
-    if (this.updates.isStarted) this.updates.stopPolling();
-    else await this.api.deleteWebhook();
+  async stop(timeout = 3e3) {
+    if (this.updates.isStarted) {
+      this.updates.stopPolling();
+    }
+    await this.updates.queue.stop(timeout);
     await this.runImmutableHooks("onStop", {
       plugins: this.dependencies,
       // biome-ignore lint/style/noNonNullAssertion: bot.init() guarantees this.info

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "gramio",
 	"type": "module",
-	"version": "0.1.5",
+	"version": "0.2.1",
 	"description": "Powerful, extensible and really type-safe Telegram Bot API framework",
 	"main": "dist/index.cjs",
 	"module": "dist/index.js",
@@ -48,17 +48,14 @@
 	},
 	"dependencies": {
 		"@gramio/callback-data": "^0.0.3",
-		"@gramio/contexts": "^0.0.23",
-		"@gramio/files": "^0.1.0",
+		"@gramio/contexts": "^0.1.2",
+		"@gramio/files": "^0.1.2",
 		"@gramio/format": "^0.1.5",
-		"@gramio/keyboards": "^1.0.0",
+		"@gramio/keyboards": "^1.0.2",
 		"@gramio/types": "^8.1.0",
-		"debug": "^4.3.7",
+		"debug": "^4.4.0",
 		"inspectable": "^3.0.2",
 		"middleware-io": "^2.8.1"
 	},
-	"overrides": {
-		"@gramio/types": "^8.1.0"
-	},
 	"files": ["dist"]
 }