telekit-lib 2.0.0 → 2.0.2

package/README.md

@@ -23,21 +23,23 @@ npm install telekit-lib
 
 ## 📖 Документация
 
-Полная документация доступна в папке [`docs/`](./docs). Откройте `docs/index.html` в вашем браузере.
+Полная и красивая документация доступна онлайн:
+👉 [**https://tahel-udev.github.io/telekit/**](https://tahel-udev.github.io/telekit/)
 
 ## ⚡ Быстрый старт
 
 ```typescript
-import { TeleKit, LocalDB } from 'telekit-lib';
+import { TeleKit } from 'telekit-lib';
 
-const bot = new TeleKit(process.env.TOKEN);
-const db = new LocalDB('users.json');
+// 1. Инициализация
+const bot = new TeleKit('YOUR_BOT_TOKEN');
 
-bot.command('start', (ctx) => {
-    db.push({ id: ctx.from.id, name: ctx.from.first_name });
-    ctx.reply('Добро пожаловать в TeleKit!');
+// 2. Простая команда
+bot.command('start', async (ctx) => {
+    await ctx.reply('Привет! Бот успешно запущен.');
 });
 
+// 3. Запуск
 bot.start();
 ```
 

package/dist/index.d.ts

@@ -71,6 +71,7 @@ export declare class Context {
     get chatId(): number | undefined;
     get from(): User | undefined;
     get text(): string | undefined;
+    get userId(): number | undefined;
     get callbackData(): string | undefined;
     reply(text: string, extra?: any): Promise<any>;
     answerCallback(text?: string, alert?: boolean): Promise<any>;

package/dist/index.js

@@ -197,6 +197,13 @@ class Context {
             return this.update.message.text;
         return undefined;
     }
+    get userId() {
+        if ('message' in this.update)
+            return this.update.message.from?.id;
+        if ('callback_query' in this.update)
+            return this.update.callback_query.from.id;
+        return undefined;
+    }
     get callbackData() {
         if ('callback_query' in this.update && 'data' in this.update.callback_query)
             return this.update.callback_query.data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "telekit-lib",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Профессиональный TypeScript фреймворк для Telegram ботов со встроенной LocalDB",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/PUBLISHING.md

@@ -1,52 +0,0 @@
-# 🚀 Руководство по публикации TeleKit
-
-Это руководство объясняет, как опубликовать вашу библиотеку в NPM, на GitHub и разместить документацию.
-
-## 1. Подготовка к NPM
-
-1.  **Войдите в NPM** (если еще не вошли):
-    ```bash
-    npm login
-    ```
-2.  **Соберите проект**:
-    ```bash
-    npm run build
-    ```
-    *Это создаст папку `dist`, которая и будет опубликована.*
-3.  **Опубликуйте**:
-    ```bash
-    npm publish --access public
-    ```
-    *Убедитесь, что версия в `package.json` уникальна (например, 2.0.0).*
-
-## 2. Отправка на GitHub
-
-1.  **Инициализируйте Git**:
-    ```bash
-    git init
-    git add .
-    git commit -m "Initial commit of TeleKit 2.0"
-    ```
-2.  **Отправьте (Push)**:
-    ```bash
-    git remote add origin https://github.com/TaHel-UDev/telekit.git
-    git branch -M main
-    git push -u origin main
-    ```
-
-## 3. Хостинг документации (Landing Page)
-
-У вас есть красивая документация в стиле "Shadcn" в папке `docs/`.
-
-**Вариант А: GitHub Pages (Самый простой)**
-1.  Перейдите в настройки репозитория (Repository Settings) > Pages.
-2.  Выберите источник: **Deploy from branch**.
-3.  Ветка: `main`, Папка: `/docs`.
-4.  Нажмите **Save**. Ваш сайт будет доступен по адресу `https://tahel-udev.github.io/telekit/` через несколько минут.
-
-**Вариант Б: Netlify / Vercel**
-1.  Перетащите папку `docs` в Netlify Drop.
-2.  Мгновенное развертывание.
-
----
-*Автор TaHel-UDev*

package/PUBLISH_GUIDE.md

@@ -1,52 +0,0 @@
-# Инструкция по публикации библиотеки в NPM
-
-Чтобы вашей библиотекой могли пользоваться другие люди (устанавливать через `npm install easy-tg-bot-lib`), её нужно опубликовать в реестре NPM.
-
-## Шаг 1: Подготовка
-1. Убедитесь, что код скомпилирован:
-   ```bash
-   npm run build
-   ```
-2. Убедитесь, что в `package.json` поле `main` указывает на `dist/index.js`, а `types` на `dist/index.d.ts`. Это уже настроено.
-3. (Опционально) Создайте файл `.npmignore`, чтобы не отправлять в NPM лишние файлы (исходники, конфиги), оставив только папку `dist` и `package.json`.
-   Содержимое `.npmignore`:
-   ```
-   src/
-   tsconfig.json
-   examples/
-   ```
-
-## Шаг 2: Регистрация в NPM
-Если у вас еще нет аккаунта:
-1. Перейдите на [npmjs.com](https://www.npmjs.com/) и зарегистрируйтесь.
-2. В терминале выполните вход:
-   ```bash
-   npm login
-   ```
-   Следуйте инструкциям (ввод username, password, email).
-
-## Шаг 3: Публикация
-1. **Важно**: Имя пакета в `package.json` (`"name": "easy-tg-bot-lib"`) должно быть уникальным во всем NPM. Скорее всего, простые имена уже заняты.
-   - Рекомендуется использовать scope (пространство имен), например `@ваш-ник/easy-bot`.
-   - Для этого измените имя в `package.json` на `@ваш-ник/easy-bot`.
-2. Выполните команду:
-   ```bash
-   npm publish --access public
-   ```
-   (Флаг `--access public` обязателен для scoped-пакетов, так как по умолчанию они считаются приватными и требуют платной подписки).
-
-## Шаг 4: Обновление версий
-Когда вы внесете изменения в код:
-1. Измените версию в `package.json` (например, с `1.0.0` на `1.0.1`).
-2. Снова выполните `npm run build`.
-3. Снова выполните `npm publish`.
-
-## Как будут устанавливать вашу библиотеку
-Пользователи будут писать:
-```bash
-npm install @ваш-ник/easy-bot
-```
-И использовать:
-```typescript
-import { EasyBot } from '@ваш-ник/easy-bot';
-```