gramio 0.1.0 → 0.1.2

package/README.md

@@ -2,7 +2,7 @@
 
 <div align="center">
 
-[![Bot API](https://img.shields.io/badge/Bot%20API-7.10-blue?logo=telegram&style=flat&labelColor=000&color=3b82f6)](https://core.telegram.org/bots/api)
+[![Bot API](https://img.shields.io/badge/Bot%20API-7.11-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)
 [![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)
@@ -19,7 +19,6 @@ TypeScript/JavaScript Telegram Bot API Framework for create your bots with conve
 
 ⚙️ **Code-generated** - Many parts are code-generated (for example, [code-generated and auto-published Telegram Bot API types](https://github.com/gramiojs/types))
 
-
 ## [Get started](https://gramio.dev/get-started)
 
 To create your new bot, you just need to write it to the console:
@@ -43,3 +42,28 @@ bot.start();
 ```
 
 For more, please see [documentation](https://gramio.dev).
+
+### GramIO in action
+
+Example which uses some interesting features.
+
+```ts
+import { Bot, format, bold, code } from "gramio";
+import { findOrRegisterUser } from "./utils";
+
+const bot = new Bot(process.env.BOT_TOKEN as string)
+    .derive("message", async () => {
+        const user = await findOrRegisterUser();
+
+        return {
+            user,
+        };
+    })
+    .on("message", (context) => {
+        context.user; // typed
+
+        return context.send(format`
+        Hi, ${bold(context.user.name)}! 
+        You balance: ${code(context.user.balance)}`);
+    });
+```

package/dist/index.cjs

@@ -1155,9 +1155,11 @@ function webhookHandler(bot, framework, secretToken) {
 Symbol.metadata ??= Symbol("Symbol.metadata");
 
 exports.Bot = Bot;
+exports.Composer = Composer;
 exports.ErrorKind = ErrorKind;
 exports.Plugin = Plugin;
 exports.TelegramError = TelegramError;
+exports.Updates = Updates;
 exports.webhookHandler = webhookHandler;
 Object.keys(callbackData).forEach(function (k) {
 	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {

package/dist/index.d.cts

@@ -277,7 +277,7 @@ interface BotOptions {
     /** Bot token */
     token: string;
     /** When the bot begins to listen for updates, `GramIO` retrieves information about the bot to verify if the **bot token is valid**
-     * and to utilize some bot metadata. For instance, this metadata can be used to strip bot mentions in commands.
+     * and to utilize some bot metadata. For example, this metadata will be used to strip bot mentions in commands.
      *
      * If you set it up, `GramIO` will not send a `getMe` request on startup.
      *
@@ -1009,4 +1009,4 @@ declare function webhookHandler<Framework extends keyof typeof frameworks>(bot:
     response: () => any;
 } ? (...args: Parameters<(typeof frameworks)[Framework]>) => ReturnType<ReturnType<(typeof frameworks)[Framework]>["response"]> : (...args: Parameters<(typeof frameworks)[Framework]>) => void;
 
-export { type AnyBot, type AnyPlugin, Bot, type BotOptions, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, Plugin, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, type WebhookHandlers, webhookHandler };
+export { type AnyBot, type AnyPlugin, Bot, type BotOptions, Composer, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, Plugin, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, Updates, type WebhookHandlers, webhookHandler };

package/dist/index.d.ts

@@ -277,7 +277,7 @@ interface BotOptions {
     /** Bot token */
     token: string;
     /** When the bot begins to listen for updates, `GramIO` retrieves information about the bot to verify if the **bot token is valid**
-     * and to utilize some bot metadata. For instance, this metadata can be used to strip bot mentions in commands.
+     * and to utilize some bot metadata. For example, this metadata will be used to strip bot mentions in commands.
      *
      * If you set it up, `GramIO` will not send a `getMe` request on startup.
      *
@@ -1009,4 +1009,4 @@ declare function webhookHandler<Framework extends keyof typeof frameworks>(bot:
     response: () => any;
 } ? (...args: Parameters<(typeof frameworks)[Framework]>) => ReturnType<ReturnType<(typeof frameworks)[Framework]>["response"]> : (...args: Parameters<(typeof frameworks)[Framework]>) => void;
 
-export { type AnyBot, type AnyPlugin, Bot, type BotOptions, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, Plugin, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, type WebhookHandlers, webhookHandler };
+export { type AnyBot, type AnyPlugin, Bot, type BotOptions, Composer, type DeriveDefinitions, type ErrorDefinitions, ErrorKind, type FilterDefinitions, type Handler, Hooks, type MaybePromise, type MaybeSuppressedParams, Plugin, type Suppress, type SuppressedAPIMethodParams, type SuppressedAPIMethodReturn, type SuppressedAPIMethods, TelegramError, Updates, type WebhookHandlers, webhookHandler };

package/dist/index.js

@@ -1156,4 +1156,4 @@ function webhookHandler(bot, framework, secretToken) {
 
 Symbol.metadata ??= Symbol("Symbol.metadata");
 
-export { Bot, ErrorKind, Plugin, TelegramError, webhookHandler };
+export { Bot, Composer, ErrorKind, Plugin, TelegramError, Updates, webhookHandler };

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "gramio",
 	"type": "module",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"description": "Powerful, extensible and really type-safe Telegram Bot API framework",
 	"main": "dist/index.cjs",
 	"module": "dist/index.js",
@@ -43,7 +43,7 @@
 		"@biomejs/biome": "1.9.4",
 		"@types/bun": "^1.1.12",
 		"@types/debug": "^4.1.12",
-		"pkgroll": "^2.5.0",
+		"pkgroll": "^2.5.1",
 		"typescript": "^5.6.3"
 	},
 	"dependencies": {
@@ -51,8 +51,8 @@
 		"@gramio/contexts": "^0.0.23",
 		"@gramio/files": "^0.1.0",
 		"@gramio/format": "^0.1.4",
-		"@gramio/keyboards": "^0.3.3",
-		"@gramio/types": "^7.10.2",
+		"@gramio/keyboards": "^1.0.0",
+		"@gramio/types": "^7.11.0",
 		"debug": "^4.3.7",
 		"inspectable": "^3.0.2",
 		"middleware-io": "^2.8.1"